1010
1111If you release a new minor version.
1212
13- * Create PR to merge ` 4.x ` into ` develop ` and merge it
14- * Rename the current minor version (e.g., ` 4.4 ` ) in Setting > Branches >
13+ * [ ] Create PR to merge ` 4.x ` into ` develop ` and merge it
14+ * [ ] Rename the current minor version (e.g., ` 4.4 ` ) in Setting > Branches >
1515 "Branch protection rules" to the next minor version. E.g. ` 4.4 ` → ` 4.5 `
16- * Delete the merged ` 4.x ` branch (This closes all PRs to the branch)
17- * Do the regular release process. Go to the next "Changelog" section
16+ * [ ] Delete the merged ` 4.x ` branch (This closes all PRs to the branch)
17+ * [ ] Do the regular release process. Go to the next "Changelog" section
1818
1919## Changelog
2020
@@ -48,47 +48,57 @@ the existing content.
4848
4949## Preparation
5050
51- * Work off direct clones of the repos so the release branches persist for a time
52- * Clone both ** codeigniter4/CodeIgniter4** and ** codeigniter4/userguide** and
51+ Work off direct clones of the repos so the release branches persist for a time.
52+
53+ * [ ] Clone both ** codeigniter4/CodeIgniter4** and ** codeigniter4/userguide** and
5354 resolve any necessary PRs
5455 ``` console
5556 git clone [email protected] :codeigniter4/CodeIgniter4.git 5657 git clone [email protected] :codeigniter4/userguide.git 5758 ```
58- * Vet the **admin/** folders for any removed hidden files (Action deploy scripts
59+ * [ ] Vet the **admin/** folders for any removed hidden files (Action deploy scripts
5960 *do not remove these*)
6061 * git diff --name-status origin/master admin/
61- * Merge any Security Advisory PRs in private forks
62+ * [ ] Merge any Security Advisory PRs in private forks
6263
6364## Process
6465
6566> ** Note** Most changes that need noting in the User Guide and docs should have
6667> been included with their PR, so this process assumes you will not be
6768> generating much new content.
6869
69- * Create a new branch `release-4.x.x`
70- * Update **system/CodeIgniter.php** with the new version number:
70+ * [ ] Create a new branch `release-4.x.x`
71+ * [ ] Update **system/CodeIgniter.php** with the new version number:
7172 `const CI_VERSION = '4.x.x';`
72- * Update **user_guide_src/source/conf.py** with the new `version = '4.x'` (if applicable)
73+ * [ ] Update **user_guide_src/source/conf.py** with the new `version = '4.x'` (if applicable)
7374 and `release = '4.x.x'`
74- * Replace **CHANGELOG.md** with the new version generated above
75- * Update **user_guide_src/source/changelogs/{version}.rst**
75+ * [ ] Replace **CHANGELOG.md** with the new version generated above
76+ * [ ] Update **user_guide_src/source/changelogs/{version}.rst**
7677 * Set the date to format `Release Date: January 31, 2021`
7778 * Remove the section titles that have no items
78- * Update **user_guide_src/source/installation/upgrade_{ver}.rst**
79+ * [ ] Update **user_guide_src/source/installation/upgrade_{ver}.rst**
7980 * fill in the "All Changes" section, and add it to **upgrading.rst**
8081 * git diff --name-status origin/master -- . ':!system'
8182 * Remove the section titles that have no items
8283 * [Minor version only] Update the "from" version in the title. E.g., `from 4.3.x` → `from 4.3.8`
83- * Commit the changes with `Prep for 4.x.x release` and push to origin
84- * Create a new PR from `release-4.x.x` to `develop`:
84+ * [ ] Commit the changes with `Prep for 4.x.x release` and push to origin
85+ * [ ] Create a new PR from `release-4.x.x` to `develop`:
8586 * Title: `Prep for 4.x.x release`
86- * Decription: `Updates changelog and version references for 4.x.x.` (plus checklist)
87- * Let all tests run, then review and merge the PR
88- * Create a new PR from `develop` to `master`:
87+ * Description:
88+ ```
89+ Updates changelog and version references for 4.x.x.
90+
91+ Previous version: #xxxx
92+ Release Code: TODO
93+ New Changelog: TODO
94+ ```
95+ (plus checklist)
96+ * [ ] Let all tests run, then review and merge the PR
97+ * [ ] Create a new PR from `develop` to `master`:
8998 * Title: `4.x.x Ready code`
9099 * Description: blank
91- * Merge the PR then create a new Release:
100+ * [ ] Merge the PR and wait for all tests.
101+ * [ ] Create a new Release:
92102 * Tag: `v4.x.x` (Create new tag)
93103 * Target: `master`
94104 * Title: `CodeIgniter 4.x.x`
@@ -103,53 +113,54 @@ the existing content.
103113
104114 **Full Changelog**: https://github.com/codeigniter4/CodeIgniter4/compare/v4.x.x...v4.x.x
105115 ```
106- * Watch for the "Deploy Distributable Repos" action to make sure **framework**,
116+ Click the "Generate release notes" button, and get the "New Contributors".
117+ * [ ] Watch for the "Deploy Distributable Repos" action to make sure **framework**,
107118 **appstarter**, and **userguide** get updated
108- * Run the following commands to install and test `appstarter` and verify the new
119+ * [ ] Run the following commands to install and test `appstarter` and verify the new
109120 version:
110121 ```console
111122 composer create-project codeigniter4/appstarter release-test
112123 cd release-test
113124 composer test && composer info codeigniter4/framework
114125 ```
115- * Verify that the user guide actions succeeded:
126+ * [ ] Verify that the user guide actions succeeded:
116127 * "[Deploy Distributable Repos](https://github.com/codeigniter4/CodeIgniter4/actions/workflows/deploy-distributables.yml)", the main repo
117128 * "[Deploy Production](https://github.com/codeigniter4/userguide/actions/workflows/deploy.yml)", UG repo
118129 * "[pages-build-deployment](https://github.com/codeigniter4/userguide/actions/workflows/pages/pages-build-deployment)", UG repo
119130 * Check if "CodeIgniter4.x.x.epub" is added to UG repo. "CodeIgniter.epub" was
120131 created when v4.3.8 was released.
121- * Fast-forward `develop` branch to catch the merge commit from `master`
132+ * [ ] Fast-forward `develop` branch to catch the merge commit from `master`
122133 ```console
123134 git fetch origin
124135 git checkout develop
125136 git merge origin/develop
126137 git merge origin/master
127138 git push origin HEAD
128139 ```
129- * Update the next minor upgrade branch `4.x`:
140+ * [ ] Update the next minor upgrade branch `4.x`:
130141 ```console
131142 git fetch origin
132143 git checkout 4.x
133144 git merge origin/4.x
134145 git merge origin/develop
135146 git push origin HEAD
136147 ```
137- * [Minor version only] Create the next minor upgrade branch `4.x`:
148+ * [ ] [ Minor version only] Create the next minor upgrade branch `4.x`:
138149 ```console
139150 git fetch origin
140151 git switch develop
141152 git switch -c 4.x
142153 git push origin HEAD
143154 ```
144- * Publish any Security Advisories that were resolved from private forks
155+ * [ ] Publish any Security Advisories that were resolved from private forks
145156 (note: publishing is restricted to administrators):
146- * Announce the release on the forums and Slack channel
157+ * [ ] Announce the release on the forums and Slack channel
147158 (note: this forum is restricted to administrators):
148159 * Make a new topic in the "News & Discussion" forums:
149160 https://forum.codeigniter.com/forum-2.html
150161 * The content is somewhat organic, but should include any major features and
151162 changes as well as a link to the User Guide's changelog
152- * Create a PR for new changelog and upgrade for the next version
163+ * [ ] Create a PR for new changelog and upgrade for the next version
153164 * Create **user_guide_src/source/changelogs/{next_version}.rst** and add it to
154165 **index.rst** (See **next-changelog-*.rst**)
155166 * Create **user_guide_src/source/installation/upgrade_{next_version}.rst** and add it to
0 commit comments