README

Helper to generate WordPress Composer packages

About

This package helps to generate Composer packages for any WordPress release.

Support us

We're dedicated to pushing modern WordPress development forward through our open source projects, and we need your support to keep building. You can support our work by purchasing Radicle, our recommended WordPress stack, or by sponsoring us on GitHub. Every contribution directly helps us create better tools for the WordPress ecosystem.

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.

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