roots/wordpress-packager

Helper to generate WordPress Composer packages

Fund package maintenance!
roots

v1.4.1 2024-03-25 11:51 UTC

README

WordPress Packager

Helper to generate WordPress Composer packages

Test

About

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

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.

Type Official Themes Plugins Beta & RC
full 3 latest official Akismet, Hello Dolly ✔️
new-bundled ✅* 3 latest official none
no-content ✅* none none

* 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.