Repository files navigation

This is the repository forwpackagist.org which allows WordPress plugins and themes to bemanaged along with other dependencies usingComposer.

More info and usage instructions atwpackagist.org or follow us onTwitter@wpackagist.

For support and discussion, please use the issue tracker above.

Example composer.json:

{"name":"acme/brilliant-wordpress-site","description":"My brilliant WordPress site","repositories":[        {"type":"composer","url":"https://wpackagist.org","only": ["wpackagist-plugin/*","wpackagist-theme/*"]        }    ],"require": {"aws/aws-sdk-php":"*","wpackagist-plugin/akismet":"dev-trunk","wpackagist-plugin/wordpress-seo":">=7.0.2","wpackagist-theme/hueman":"*"    },"autoload": {"psr-0": {"Acme":"src/"        }    }}

This does not provide WordPress itself.

Seehttps://github.com/fancyguy/webroot-installer orhttps://github.com/roots/wordpress.

WPackagist implements thewordpress-plugin andwordpress-theme Composer Installers(https://github.com/composer/installers).

It essentially provides a lookup table from package (theme or plugin) name to WordPress.orgSVN repository. Versions correspond to different tags in their repository, with the specialdev-trunk version being mapped totrunk.

Note that to maintain Composer v1 compatibility (as well as v2)fordev- versions, for now we need to use theVersionParser fromcomposer/composer v1.x and not a newer release branch. Correct resolutionof these depends on the legacy behaviour wheredev-trunk et al. correspond to

"version_normalized":"9999999-dev"

The lookup table is provided as a hierarchy of static JSON files. The entry point to thesefiles can be found athttps://wpackagist.org/packages.json, which consists of a series ofsub-tables (each as its own JSON file). These sub-tables are grouped by last commitdate (trying to keep them roughly the same size), and contain references to individual packages.Each package has its own JSON file detailing its versions; these can be found inhttps://wpackagist.org/p/wpackagist-{theme|plugin}/{package-name-and-hash}.json.

Currently, Wpackagist can only process packages with up to 4 parts in their version numbers, in line withthe internal handling of Composer v1.x.

1. Make sure you have Composer dependencies installed, including extensions.
2. Make.env.local, overriding anything you want to from.env.
3. (Only if you're going to skip using a database forPackageStore): ensure sure yourPACKAGE_PATH directory is writable.
4. Runcomposer install to install dependencies.
5. Populate the database and package files (see steps below).
6. Point your Web server toweb. A.htaccess is provided for Apache.

The first database population may easily take hours. Be patient.

0. bin/console doctrine:migrations:migrate: Ensure the database schema is up to date with the code.
1. bin/console refresh: Query the WordPress.org SVN in order to find new and updated packages.
2. bin/console update: Update the version information for packages identified in2. Uses the WordPress.org API.
3. bin/console build: Rebuild allPackageStore data.

This may be simpler than setting up native dependencies, but isexperimental.

To prepare environment variables:

cp .env .env.local

and edit as necessary.

To set up and update the database:

docker-compose run --rm cron composer installdocker-compose run --rm cron deploy/migrate-db.shdocker-compose run --rm cron

To start a web server onlocalhost:30100:

docker-compose up web adminer

• Web:localhost:30100
• Adminer:localhost:30101 (See credentials in.env.postgres.local)

CircleCI is used to deploy the live app on ECS.

Automatic deploys run:

• fromdevelop toStaging;
• frommain toProduction

See.circleci/config.yml for full configuration.