Skip to content

Add a new bundle-specific README #476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danielbachhuber merged 2 commits into from
Feb 7, 2023
Merged

Add a new bundle-specific README #476

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb0aa99
Add a new bundle-specific README
danielbachhuber Jan 27, 2023
c431b28
Include mention of special versioning behavior
danielbachhuber Feb 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README-new.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
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/).
Comment thread
danielbachhuber marked this conversation as resolved.
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.