From eb0aa9997353247681b928b20a58e4fd0493d7ca Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Fri, 27 Jan 2023 10:05:12 -0800 Subject: [PATCH 1/2] Add a new bundle-specific README --- README-new.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 README-new.md diff --git a/README-new.md b/README-new.md new file mode 100644 index 000000000..e4d6bc67b --- /dev/null +++ b/README-new.md @@ -0,0 +1,8 @@ +wp-cli/wp-cli-bundle +================= + +Combines the most common commands into the standard, installable version of WP-CLI. + +Generally, bundled commands either relate directly to a WordPress API or offer some common developer convenience. New commands are included in the WP-CLI bundle when the [project governance](https://make.wordpress.org/cli/handbook/contributions/governance/) decides they should be. There isn't much of a formal process to it, so feel free to ask if you ever have a question. + +The handbook documents the [various ways you can install the bundle](https://make.wordpress.org/cli/handbook/guides/installing/). The Phar is [built on every merge](https://github.com/wp-cli/wp-cli-bundle/blob/main/.github/workflows/deployment.yml) and pushed to [wp-cli/builds](https://github.com/wp-cli/builds) repository. A stable version is [tagged a few times each year](https://make.wordpress.org/cli/handbook/contributions/release-checklist/). From c431b28a4f529d8ba296dacaa01d0b2aed24e9a5 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Tue, 7 Feb 2023 09:04:44 -0800 Subject: [PATCH 2/2] Include mention of special versioning behavior Co-authored-by: Alain Schlesser --- README-new.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README-new.md b/README-new.md index e4d6bc67b..9e0c5931b 100644 --- a/README-new.md +++ b/README-new.md @@ -6,3 +6,4 @@ Combines the most common commands into the standard, installable version of WP-C Generally, bundled commands either relate directly to a WordPress API or offer some common developer convenience. New commands are included in the WP-CLI bundle when the [project governance](https://make.wordpress.org/cli/handbook/contributions/governance/) decides they should be. There isn't much of a formal process to it, so feel free to ask if you ever have a question. The handbook documents the [various ways you can install the bundle](https://make.wordpress.org/cli/handbook/guides/installing/). The Phar is [built on every merge](https://github.com/wp-cli/wp-cli-bundle/blob/main/.github/workflows/deployment.yml) and pushed to [wp-cli/builds](https://github.com/wp-cli/builds) repository. A stable version is [tagged a few times each year](https://make.wordpress.org/cli/handbook/contributions/release-checklist/). +Both `wp-cli/wp-cli` and `wp-cli/wp-cli-bundle` use milestones to indicate the next stable release. For `wp-cli/wp-cli`, the milestone represents the version of the WP-CLI framework. For `wp-cli/wp-cli-bundle`, the milestone represents the WP-CLI Phar version. We keep these in sync for backwards compatibility reasons, and to avoid causing confusion with third party commands. Each of the command repositories are versioned independently according to semantic versioning principles as needed.