From a50d739e50096db50346c62f16b242650093e2e5 Mon Sep 17 00:00:00 2001 From: Owen Voke Date: Mon, 9 Nov 2020 10:46:30 +0000 Subject: [PATCH] docs: add release guide --- RELEASE.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 00000000..82a6b432 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,12 @@ +# Release process + +When releasing a new version of Pest there are some checks and updates that need to be done: + +- Clear your local repository with: `git add . && git reset --hard && git checkout master` +- On the GitHub repository, check the contents of [github.com/pestphp/pest/compare/{latest_version}...master](https://github.com/pestphp/pest/compare/{latest_version}...master) and update the [changelog](CHANGELOG.md) file with the main changes for this release +- Update the version number in [src/Pest.php](src/Pest.php) +- Run the tests locally using: `composer test` +- Commit the CHANGELOG and Pest file with the message: `git commit -m "chore: update changelog"` +- Push the changes to GitHub +- Check that the CI is passing as expected: [github.com/pestphp/pest/actions](https://github.com/pestphp/pest/actions) +- Tag and push the tag with `git tag vX.X.X && git push --tags`