Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

56 lines (35 loc) · 2.35 KB
Raw

Contributing

Running locally

Start local site with:

wp-env start

Change permalink structure:

wp-env run cli "wp rewrite structure '/%postname%'"

The site is now available at http://localhost:8888.

Releasing

This section documents the process for issuing a new release.

Create a PR for the release

You'll need jq, which on macOS can be installed with brew install jq.

You'll need the GitHub CLI, which on macOS can be installed with brew install gh.

You'll also need to login to the GitHub CLI with gh auth login, if you haven't already.

You can prepare a release with the following command (using 1.2.3 as example):

Make sure to consider Semantic Versioning to decide which version you're issuing.

bin/prepare-release.sh 1.2.3

A new draft PR will now have been created, and its branch checked out locally.

Run the tests

You must make sure tests pass before publishing a new release. See End-to-end tests for instructions on running the tests.

Add a Changelog

A Changelog must be added to the Changelog section of README.md. In the PR description, you can find a link to all the commits since the previous release. You should manually go through the list and identify merged PRs that should be included in the Changelog (i.e. PRs that result in user-facing changes).

You should push a commit with the new Changelog entry to the release branch, and then copy the Changelog to the PR description as well.

Merge the PR

Once you're satisfied with the release, you can merge the PR. The PR will be merged into the main branch, and a GitHub Action will be triggered which will create a draft release on GitHub.

Publish the release

Copy the Changelog entry from the PR description (or README.md) into the release description, then publish the release. Publishing the release will trigger a GitHub Action which will publish the release to the WordPress Plugin Directory.

Go to the plugin directory page and make sure the new version is available. This might take up to a few minutes.

Done

The release has been published to both GitHub and the WordPress Plugin Directory. You can now delete the release branch from your local machine.