Skip to content

Commit 6eacd2e

Browse files
authored
Merge pull request #104 from 10up/docs/release-instruction
2 parents de0553e + 1418858 commit 6eacd2e

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ This repository currently uses the `develop` branch to reflect active work and `
2828

2929
## Release instructions
3030

31-
1. [Create a new release](https://github.com/10up/action-wordpress-plugin-deploy/releases/new)
32-
2. Ensure it appears in the GitHub Marketplace correctly
33-
3. Celebrate shipping!
31+
1. Branch: Starting from `develop`, cut a release branch named `release/X.Y.Z` for your changes.
32+
1. Changelog: Add/update the changelog in `CHANGELOG.md`.
33+
1. Props: update `CREDITS.md` file with any new contributors, confirm maintainers are accurate.
34+
1. Readme updates: Make any other readme changes as necessary in `README.md`.
35+
1. Merge: Make a non-fast-forward merge from your release branch to `develop` (or merge the pull request), then merge `develop` into `stable` (`git checkout stable && git merge --no-ff develop`).
36+
1. Push: Push your stable branch to GitHub (e.g. `git push origin stable`).
37+
1. Release: Create a [new release](https://github.com/10up/action-wordpress-plugin-deploy/releases/new), naming the tag and the release with the new version number, and targeting the `stable` branch. Paste the changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues on the [milestone](https://github.com/10up/action-wordpress-plugin-deploy/milestones/#?closed=1). The release should now appear under [releases](https://github.com/10up/action-wordpress-plugin-deploy/releases).
38+
1. Ensure the release [appears in the GitHub Marketplace](https://github.com/marketplace/actions/wordpress-plugin-deploy) correctly.
39+
1. Close milestone: Edit the [milestone](https://github.com/10up/action-wordpress-plugin-deploy/milestones/) with release date (in the `Due date (optional)` field) and link to GitHub release (in the `Description field`), then close the milestone.
40+
1. Punt incomplete items: If any open issues or PRs which were milestoned for `X.Y.Z` do not make it into the release, update their milestone to `X.Y.Z+1`, `X.Y+1.0`, `X+1.0.0` or `Future Release`.
41+
1. Celebrate shipping!

0 commit comments

Comments
 (0)