Skip to content

Add a CONTRIBUTING.md explaining the release process #224

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

Open
kadamwhite wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add a CONTRIBUTING.md explaining the release process #224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Contributing

## Release Process

1. In a pull request off of `master`,
- bump the version number in the [plugin.php](./plugin.php) comment header
- update the [CHANGELOG.md](./CHANGELOG.md) with a list of features to be released
2. Get sign-off from a teammate and merge the version bump PR
3. Create a tag on `master` matching the updated version number in [plugin.php](./plugin.php)
4. Push the tag to GitHub

When you push the release tag, a [GitHub Actions workflow](https://github.com/humanmade/Workflows/actions/workflows/release.yml) will automatically build the plugin and re-point your newly pushed tag to the SHA containing the built code, then promote that tag to a [release](https://github.com/humanmade/Workflows/releases).
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@
Powerful workflows for WordPress

Read the [API documentation on the Wiki](https://github.com/humanmade/Workflows/wiki), or learn more in [the Altis DXP documentation](https://www.altis-dxp.com/resources/docs/workflow/).

## Release Process

See [CONTRIBUTING.md](./CONTRIBUTING.md).