https://github.com/roots/wordpress-packager

Helper to generate WordPress Composer packages
https://github.com/roots/wordpress-packager

composer helper wordpress wordpress-composer

Last synced: 3 months ago
JSON representation

Helper to generate WordPress Composer packages

• Host: GitHub
• URL: https://github.com/roots/wordpress-packager
• Owner: roots
• License: mit
• Created: 2019-05-27T01:29:54.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-30T11:42:33.000Z (9 months ago)
• Last Synced: 2024-05-01T09:50:41.452Z (9 months ago)
• Topics: composer, helper, wordpress, wordpress-composer
• Language: PHP
• Homepage:
• Size: 1.05 MB
• Stars: 37
• Watchers: 6
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# WordPress Packager

> Helper to generate WordPress Composer packages

[![Test](https://github.com/roots/wordpress-packager/actions/workflows/test.yml/badge.svg)](https://github.com/roots/wordpress-packager/actions/workflows/test.yml)

## About

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

## Usage

```bash

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

```

### Repository remote ``

Required.

A valid git repository remote.  

Eg. `https://github.com/org/project.git`

### Package name ``

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`](https://github.com/roots/wordpress-packager/blob/main/src/ReleaseSources/SourceInterface.php).  

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](https://wordpress.org/themes/author/wordpressdotorg/)|[Akismet](https://wordpress.org/plugins/akismet/), [Hello Dolly](https://wordpress.org/plugins/hello-dolly/)|✔️

`new-bundled`|✅*|[3 latest official](https://wordpress.org/themes/author/wordpressdotorg/)|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.