10
10
11
11
If you release a new minor version.
12
12
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 >
15
15
"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
18
18
19
19
## Changelog
20
20
@@ -48,47 +48,57 @@ the existing content.
48
48
49
49
## Preparation
50
50
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
53
54
resolve any necessary PRs
54
55
``` console
55
56
git clone [email protected] :codeigniter4/CodeIgniter4.git
56
57
git clone [email protected] :codeigniter4/userguide.git
57
58
```
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
59
60
*do not remove these*)
60
61
* 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
62
63
63
64
## Process
64
65
65
66
> ** Note** Most changes that need noting in the User Guide and docs should have
66
67
> been included with their PR, so this process assumes you will not be
67
68
> generating much new content.
68
69
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:
71
72
`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)
73
74
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**
76
77
* Set the date to format `Release Date: January 31, 2021`
77
78
* 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**
79
80
* fill in the "All Changes" section, and add it to **upgrading.rst**
80
81
* git diff --name-status origin/master -- . ':!system'
81
82
* Remove the section titles that have no items
82
83
* [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`:
85
86
* 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`:
89
98
* Title: `4.x.x Ready code`
90
99
* 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:
92
102
* Tag: `v4.x.x` (Create new tag)
93
103
* Target: `master`
94
104
* Title: `CodeIgniter 4.x.x`
@@ -103,53 +113,54 @@ the existing content.
103
113
104
114
**Full Changelog**: https://github.com/codeigniter4/CodeIgniter4/compare/v4.x.x...v4.x.x
105
115
```
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**,
107
118
**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
109
120
version:
110
121
```console
111
122
composer create-project codeigniter4/appstarter release-test
112
123
cd release-test
113
124
composer test && composer info codeigniter4/framework
114
125
```
115
- * Verify that the user guide actions succeeded:
126
+ * [ ] Verify that the user guide actions succeeded:
116
127
* "[Deploy Distributable Repos](https://github.com/codeigniter4/CodeIgniter4/actions/workflows/deploy-distributables.yml)", the main repo
117
128
* "[Deploy Production](https://github.com/codeigniter4/userguide/actions/workflows/deploy.yml)", UG repo
118
129
* "[pages-build-deployment](https://github.com/codeigniter4/userguide/actions/workflows/pages/pages-build-deployment)", UG repo
119
130
* Check if "CodeIgniter4.x.x.epub" is added to UG repo. "CodeIgniter.epub" was
120
131
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`
122
133
```console
123
134
git fetch origin
124
135
git checkout develop
125
136
git merge origin/develop
126
137
git merge origin/master
127
138
git push origin HEAD
128
139
```
129
- * Update the next minor upgrade branch `4.x`:
140
+ * [ ] Update the next minor upgrade branch `4.x`:
130
141
```console
131
142
git fetch origin
132
143
git checkout 4.x
133
144
git merge origin/4.x
134
145
git merge origin/develop
135
146
git push origin HEAD
136
147
```
137
- * [Minor version only] Create the next minor upgrade branch `4.x`:
148
+ * [ ] [ Minor version only] Create the next minor upgrade branch `4.x`:
138
149
```console
139
150
git fetch origin
140
151
git switch develop
141
152
git switch -c 4.x
142
153
git push origin HEAD
143
154
```
144
- * Publish any Security Advisories that were resolved from private forks
155
+ * [ ] Publish any Security Advisories that were resolved from private forks
145
156
(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
147
158
(note: this forum is restricted to administrators):
148
159
* Make a new topic in the "News & Discussion" forums:
149
160
https://forum.codeigniter.com/forum-2.html
150
161
* The content is somewhat organic, but should include any major features and
151
162
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
153
164
* Create **user_guide_src/source/changelogs/{next_version}.rst** and add it to
154
165
**index.rst** (See **next-changelog-*.rst**)
155
166
* Create **user_guide_src/source/installation/upgrade_{next_version}.rst** and add it to
0 commit comments