README

This package helps generate Composer packages for any WordPress release.

Support us

Roots is an independent open source org, supported only by developers like you. Your sponsorship funds WP Packages and the entire Roots ecosystem, and keeps them independent. Support us by purchasing Radicle or sponsoring us on GitHub — sponsors get access to our private Discord.

Usage

$ vendor/bin/wordpress-packager [--source SOURCE] [-t|--type TYPE] [-u|--unstable] [--] <remote> <package>

Repository remote <remote>

Required.

A valid git repository remote.
Eg. https://github.com/org/project.git

Package name <package>

Required.

A valid Composer package name.
Eg. wordpress-package

Release source --source SOURCE

Optional, default WPDotOrgAPI.

Must be a PHP class implementing Roots\WordPressPackager\ReleaseSources\SourceInterface.
Provides the implementation of data generation for packages.

Release type -t|--type TYPE

Optional, default full.

Different release types are available as WordPress core deliveries.
The list of themes and plugins bundled differs between release types.

* Although they are not extensively documented, these builds are made available by WordPress.org as regular builds.

Unstable releases --unstable

Optional.

If set, the available unstable releases (beta & release candidates) will be added as well.

Related

• WP Packages — All WordPress.org plugins and themes as a Composer repository

Community

Keep track of development and community news.

• Join us on Discord by sponsoring us on GitHub
• Join us on Roots Discourse
• Follow @rootswp on Twitter
• Follow the Roots Blog
• Subscribe to the Roots Newsletter