From 8404b3dc9e34a33393157e2db5c63b6b5a7bf61a Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 9 Oct 2023 15:25:21 +0900 Subject: [PATCH] docs: small improvements --- admin/RELEASE.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/admin/RELEASE.md b/admin/RELEASE.md index 69cb216b2..5940307c3 100644 --- a/admin/RELEASE.md +++ b/admin/RELEASE.md @@ -36,11 +36,11 @@ the changelog. ## Preparation -* Clone **codeigniter4/shield** and resolve any necessary PRs +* [ ] Clone **codeigniter4/shield** and resolve any necessary PRs ```console git clone git@github.com:codeigniter4/shield.git ``` -* Merge any Security Advisory PRs in private forks +* [ ] Merge any Security Advisory PRs in private forks ## Process @@ -48,29 +48,31 @@ the changelog. > been included with their PR, so this process assumes you will not be > generating much new content. -* Create a new branch `release-1.x.x` -* Update **src/Auth.php** with the new version number: +* [ ] Create a new branch `release-1.x.x` +* [ ] Update **src/Auth.php** with the new version number: `const SHIELD_VERSION = '1.x.x';` -* Commit the changes with "Prep for 1.x.x release" and push to origin -* Create a new PR from `release-1.x.x` to `develop`: +* [ ] Commit the changes with "Prep for 1.x.x release" and push to origin +* [ ] Create a new PR from `release-1.x.x` to `develop`: * Title: "Prep for 1.x.x release" * Description: "Updates version references for `1.x.x`." (plus checklist) -* Let all tests run, then review and merge the PR -* Create a new PR from `develop` to `master`: +* [ ] Let all tests run, then review and merge the PR +* [ ] Create a new PR from `develop` to `master`: * Title: "1.x.x Ready code" * Description: blank -* Merge the PR -* Create a new Release: +* [ ] Merge the PR +* [ ] Create a new Release: * Version: "v1.x.x" * Target: master * Title: "v1.x.x" * Click the "Generate release notes" button * Remove "### Others (Only for checking. Remove this category)" section + * Add important notes if necessary + * Add link to Upgrade Guide if necessary * Check "Create a discussion for this release" * Click the "Publish release" button -* Watch for the "docs" action and verify that the user guide updated: +* [ ] Watch for the "docs" action and verify that the user guide updated: * [docs](https://github.com/codeigniter4/shield/actions/workflows/docs.yml) -* Fast-forward `develop` branch to catch the merge commit from `master` +* [ ] Fast-forward `develop` branch to catch the merge commit from `master` (note: pushing to `develop` is restricted to administrators): ```console git fetch origin @@ -82,9 +84,9 @@ the changelog. **At this point, `master` must be merged into `develop`.** Otherwise, the GitHub-generated release note from `develop` for the next release will not be generated correctly. -* Publish any Security Advisories that were resolved from private forks +* [ ] Publish any Security Advisories that were resolved from private forks (note: publishing is restricted to administrators) -* Announce the release on the forums and Slack channel +* [ ] Announce the release on the forums and Slack channel (note: this forum is restricted to administrators): * Make a new topic in the "News & Discussion" forums: https://forum.codeigniter.com/forum-2.html