From a50d739e50096db50346c62f16b242650093e2e5 Mon Sep 17 00:00:00 2001 From: Owen Voke Date: Mon, 9 Nov 2020 10:46:30 +0000 Subject: [PATCH 1/3] 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` From a1b142e885f7ab7c9b02588e090e35703f54201f Mon Sep 17 00:00:00 2001 From: Owen Voke Date: Thu, 26 Nov 2020 19:55:42 +0000 Subject: [PATCH 2/3] docs: add details on plugin versioning --- RELEASE.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/RELEASE.md b/RELEASE.md index 82a6b432..3773c551 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -10,3 +10,7 @@ When releasing a new version of Pest there are some checks and updates that need - 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` + +### Plugins + +Plugins should be versioned using the same major (or minor for `0.x` releases) version as Pest core. From d88c2684269a4ccd948383477ba6348169d25cac Mon Sep 17 00:00:00 2001 From: Owen Voke Date: Fri, 27 Nov 2020 09:13:38 +0000 Subject: [PATCH 3/3] docs: use docs prefix in release commit message --- RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index 3773c551..221afea2 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -6,7 +6,7 @@ When releasing a new version of Pest there are some checks and updates that need - 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"` +- Commit the CHANGELOG and Pest file with the message: `git commit -m "docs: 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`