Skip to content

Latest commit

 

History

History
218 lines (129 loc) · 6.1 KB

README.md

File metadata and controls

218 lines (129 loc) · 6.1 KB
Raw

wp-cli/wp-cli-dev

Sets up a WP-CLI development environment that allows for easy development across all packages.

This allows easy development across all packages and contains additional maintenance commands that simplify repository chores and the release process.

Quick links: Installation | Development | Using | Contributing | Support

Installation

Clone this repository onto your hard drive and then use Composer to install all dependencies:

git clone https://github.com/wp-cli/wp-cli-dev
cd wp-cli-dev
composer install

This will:

  1. Clone all relevant packages from the wp-cli GitHub organization into the wp-cli-dev folder, and
  2. Install all Composer dependencies for a complete wp-cli-bundle setup, while symlinking all of the previously cloned packages into the Composer vendor folder.
  3. Symlink all folder in vendor into corresponding vendor folders in each repository, thus making the centralized functionality based on Composer available in each repository subfolder.

Development

Every subfolder is a proper clone of the corresponding GitHub repository. This means that you can create new branches, make your changes, commit to the new branch and then submit as pull-request, all from within these folders.

As the folders are also symlinked into the Composer vendor folder, you will always have the latest changes available when running WP-CLI through the vendor/bin/wp executable.

Using

This package implements the following commands:

wp maintenance

Provides tools to manage the WP-CLI GitHub organization and the release process.

wp maintenance

wp maintenance contrib-list

Lists all contributors to this release.

wp maintenance contrib-list [--format=<format>]

Run within the main WP-CLI project repository.

OPTIONS

[--format=<format>]
	Render output in a specific format.
	---
	default: markdown
	options:
	  - markdown
	  - html
	---

wp maintenance milestones-after

Retrieves the milestones that were closed after a given milestone.

wp maintenance milestones-after <repo> <milestone>

OPTIONS

<repo>
	Name of the repository to fetch the milestones for.

<milestone>
	Milestone to serve as treshold.

wp maintenance milestones-since

Retrieves the milestones that were closed for a given repository after a

wp maintenance milestones-since <repo> <date>

specific date treshold.

OPTIONS

<repo>
	Name of the repository to fetch the milestones for.

<date>
	Threshold date to filter by.

wp maintenance release-date

Retrieves the date a given release for a repository was published at.

wp maintenance release-date <repo> <release>

OPTIONS

<repo>
	Name of the repository to fetch the release notes for. If no user/org
	was provided, 'wp-cli' org is assumed.

<release>
	Name of the release to fetch the release notes for.

wp maintenance release-notes

Gets the release notes for one or more milestones of a repository.

wp maintenance release-notes [<repo>] [<milestone>...] [--source=<source>] [--format=<format>]

OPTIONS

[<repo>]
	Name of the repository to fetch the release notes for. If no user/org
	was provided, 'wp-cli' org is assumed. If no repo is passed, release
	notes for the entire org state since the last bundle release are fetched.

[<milestone>...]
	Name of one or more milestones to fetch the release notes for. If none
	are passed, the currently open one is assumed.

[--source=<source>]
	Choose source from where to copy content.
	---
	default: release
	options:
	  - release
	  - pull-request

[--format=<format>]
	Render output in a specific format.
	---
	default: markdown
	options:
	  - markdown
	  - html
	---

wp maintenance replace-label

Replaces a label with a different one, and optionally deletes the old

wp maintenance replace-label <repo> <old-label> <new-label> [--delete]

label.

OPTIONS

<repo>
	Name of the repository you want to replace a label for.

<old-label>
	Old label to replace on all issues.

<new-label>
	New label to replace it with.

[--delete]
	Delete the old label after the operation is complete.

Contributing

We appreciate you taking the initiative to contribute to this project.

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.

For a more thorough introduction, check out WP-CLI's guide to contributing. This package follows those policies and guidelines.

Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed.

Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please create a new issue. Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, review our bug report documentation.

Creating a pull request

Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project.

Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience. See "Setting up" for details specific to working on this package locally.

Support

Github issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support