@@ -36,41 +36,43 @@ the changelog.
3636
3737## Preparation
3838
39- * Clone ** codeigniter4/shield** and resolve any necessary PRs
39+ * [ ] Clone ** codeigniter4/shield** and resolve any necessary PRs
4040 ``` console
4141 git clone git@github.com:codeigniter4/shield.git
4242 ```
43- * Merge any Security Advisory PRs in private forks
43+ * [ ] Merge any Security Advisory PRs in private forks
4444
4545## Process
4646
4747> ** Note** Most changes that need noting in the User Guide and docs should have
4848> been included with their PR, so this process assumes you will not be
4949> generating much new content.
5050
51- * Create a new branch `release-1.x.x`
52- * Update **src/Auth.php** with the new version number:
51+ * [ ] Create a new branch `release-1.x.x`
52+ * [ ] Update **src/Auth.php** with the new version number:
5353 `const SHIELD_VERSION = '1.x.x';`
54- * Commit the changes with "Prep for 1.x.x release" and push to origin
55- * Create a new PR from `release-1.x.x` to `develop`:
54+ * [ ] Commit the changes with "Prep for 1.x.x release" and push to origin
55+ * [ ] Create a new PR from `release-1.x.x` to `develop`:
5656 * Title: "Prep for 1.x.x release"
5757 * Description: "Updates version references for `1.x.x`." (plus checklist)
58- * Let all tests run, then review and merge the PR
59- * Create a new PR from `develop` to `master`:
58+ * [ ] Let all tests run, then review and merge the PR
59+ * [ ] Create a new PR from `develop` to `master`:
6060 * Title: "1.x.x Ready code"
6161 * Description: blank
62- * Merge the PR
63- * Create a new Release:
62+ * [ ] Merge the PR
63+ * [ ] Create a new Release:
6464 * Version: "v1.x.x"
6565 * Target: master
6666 * Title: "v1.x.x"
6767 * Click the "Generate release notes" button
6868 * Remove "### Others (Only for checking. Remove this category)" section
69+ * Add important notes if necessary
70+ * Add link to Upgrade Guide if necessary
6971 * Check "Create a discussion for this release"
7072 * Click the "Publish release" button
71- * Watch for the "docs" action and verify that the user guide updated:
73+ * [ ] Watch for the "docs" action and verify that the user guide updated:
7274 * [docs](https://github.com/codeigniter4/shield/actions/workflows/docs.yml)
73- * Fast-forward `develop` branch to catch the merge commit from `master`
75+ * [ ] Fast-forward `develop` branch to catch the merge commit from `master`
7476 (note: pushing to `develop` is restricted to administrators):
7577 ```console
7678 git fetch origin
@@ -82,9 +84,9 @@ the changelog.
8284 **At this point, `master` must be merged into `develop`.** Otherwise, the
8385 GitHub-generated release note from `develop` for the next release will not be
8486 generated correctly.
85- * Publish any Security Advisories that were resolved from private forks
87+ * [ ] Publish any Security Advisories that were resolved from private forks
8688 (note: publishing is restricted to administrators)
87- * Announce the release on the forums and Slack channel
89+ * [ ] Announce the release on the forums and Slack channel
8890 (note: this forum is restricted to administrators):
8991 * Make a new topic in the "News & Discussion" forums:
9092 https://forum.codeigniter.com/forum-2.html
0 commit comments