@@ -32,8 +32,8 @@ To auto-generate, navigate to the
32
32
[ Releases] ( https://github.com/codeigniter4/CodeIgniter4/releases ) page,
33
33
click the "Draft a new release" button.
34
34
35
- * Tag: " v4.x.x" (Create new tag)
36
- * Target: develop
35
+ * Tag: ` v4.x.x ` (Create new tag)
36
+ * Target: ` develop `
37
37
38
38
Click the "Generate release notes" button.
39
39
@@ -49,10 +49,10 @@ the existing content.
49
49
* Work off direct clones of the repos so the release branches persist for a time
50
50
* Clone both ** codeigniter4/CodeIgniter4** and ** codeigniter4/userguide** and
51
51
resolve any necessary PRs
52
- ``` console
53
- git clone [email protected] :codeigniter4/CodeIgniter4.git
54
- git clone [email protected] :codeigniter4/userguide.git
55
- ```
52
+ ``` console
53
+ git clone [email protected] :codeigniter4/CodeIgniter4.git
54
+ git clone [email protected] :codeigniter4/userguide.git
55
+ ```
56
56
* Vet the **admin/** folders for any removed hidden files (Action deploy scripts
57
57
*do not remove these*)
58
58
* Merge any Security Advisory PRs in private forks
69
69
* Update **user_guide_src/source/conf.py** with the new `version = '4.x'` (if applicable)
70
70
and `release = '4.x.x'`
71
71
* Replace **CHANGELOG.md** with the new version generated above
72
- * Set the date in ** user_guide_src/source/changelogs/{version}.rst** to format
73
- ` Release Date: January 31, 2021 `
74
- * Create a new changelog for the next version at
75
- ** user_guide_src/source/changelogs/{next_version}.rst** and add it to
76
- ** index.rst**
77
- * Create ** user_guide_src/source/installation/upgrade_ {ver}.rst** , fill in the
78
- "All Changes" section, and add it to ** upgrading.rst**
72
+ * Update **user_guide_src/source/changelogs/{version}.rst**
73
+ * Set the date to format `Release Date: January 31, 2021`
74
+ * Remove the section titles that have no items
75
+ * Update **user_guide_src/source/installation/upgrade_{ver}.rst**
76
+ * fill in the "All Changes" section, and add it to **upgrading.rst**
79
77
* git diff --name-status origin/master -- . ':!system'
80
- * Commit the changes with "Prep for 4.x.x release" and push to origin
78
+ * Remove the section titles that have no items
79
+ * Commit the changes with `Prep for 4.x.x release` and push to origin
81
80
* Create a new PR from `release-4.x.x` to `develop`:
82
- * Title: " Prep for 4.x.x release"
83
- * Decription: " Updates changelog and version references for ` 4.x.x ` ." (plus checklist)
81
+ * Title: ` Prep for 4.x.x release`
82
+ * Decription: ` Updates changelog and version references for 4.x.x.` (plus checklist)
84
83
* Let all tests run, then review and merge the PR
85
84
* Create a new PR from `develop` to `master`:
86
- * Title: " 4.x.x Ready code"
87
- * Description: blank
85
+ * Title: ` 4.x.x Ready code`
86
+ * Description: blank
88
87
* Merge the PR then create a new Release:
89
- * Version: " v4.x.x"
90
- * Target: master
91
- * Title: " CodeIgniter 4.x.x"
92
- * Description:
93
- ```
94
- CodeIgniter 4.x.x release.
88
+ * Version: ` v4.x.x`
89
+ * Target: ` master`
90
+ * Title: ` CodeIgniter 4.x.x`
91
+ * Description:
92
+ ```
93
+ CodeIgniter 4.x.x release.
95
94
96
- See the changelog: https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md
95
+ See the changelog: https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md
97
96
98
- ## New Contributors
99
- *
97
+ ## New Contributors
98
+ *
100
99
101
- Full Changelog: https://github.com/codeigniter4/CodeIgniter4/compare/v4.x.x...v4.x.x
102
- ```
100
+ Full Changelog: https://github.com/codeigniter4/CodeIgniter4/compare/v4.x.x...v4.x.x
101
+ ```
103
102
* Watch for the "Deploy Distributable Repos" action to make sure **framework**,
104
103
**appstarter**, and **userguide** get updated
105
104
* Run the following commands to install and test `appstarter` and verify the new
106
105
version:
107
- ``` console
108
- composer create-project codeigniter4/appstarter release-test
109
- cd release-test
110
- composer test && composer info codeigniter4/framework
111
- ```
106
+ ```console
107
+ composer create-project codeigniter4/appstarter release-test
108
+ cd release-test
109
+ composer test && composer info codeigniter4/framework
110
+ ```
112
111
* Verify that the user guide actions succeeded:
113
- * "[ Deploy Distributable Repos] ( https://github.com/codeigniter4/CodeIgniter4/actions/workflows/deploy-distributables.yml ) ", the main repo
114
- * "[ Deploy Production] ( https://github.com/codeigniter4/userguide/actions/workflows/deploy.yml ) ", UG repo
115
- * "[ pages-build-deployment] ( https://github.com/codeigniter4/userguide/actions/workflows/pages/pages-build-deployment ) ", UG repo
112
+ * "[Deploy Distributable Repos](https://github.com/codeigniter4/CodeIgniter4/actions/workflows/deploy-distributables.yml)", the main repo
113
+ * "[Deploy Production](https://github.com/codeigniter4/userguide/actions/workflows/deploy.yml)", UG repo
114
+ * "[pages-build-deployment](https://github.com/codeigniter4/userguide/actions/workflows/pages/pages-build-deployment)", UG repo
116
115
* Fast-forward `develop` branch to catch the merge commit from `master`
117
- ``` console
118
- git fetch origin
119
- git checkout develop
120
- git merge origin/develop
121
- git merge origin/master
122
- git push origin HEAD
123
- ```
116
+ ```console
117
+ git fetch origin
118
+ git checkout develop
119
+ git merge origin/develop
120
+ git merge origin/master
121
+ git push origin HEAD
122
+ ```
124
123
* Update the next minor upgrade branch `4.x`:
125
- ``` console
126
- git fetch origin
127
- git checkout 4.x
128
- git merge origin/4.x
129
- git merge origin/develop
130
- git push origin HEAD
131
- ```
124
+ ```console
125
+ git fetch origin
126
+ git checkout 4.x
127
+ git merge origin/4.x
128
+ git merge origin/develop
129
+ git push origin HEAD
130
+ ```
132
131
* [Minor version only] Create the next minor upgrade branch `4.x`:
133
- ``` console
134
- git fetch origin
135
- git switch develop
136
- git switch -c 4.x
137
- git push origin HEAD
138
- ```
132
+ ```console
133
+ git fetch origin
134
+ git switch develop
135
+ git switch -c 4.x
136
+ git push origin HEAD
137
+ ```
139
138
* Publish any Security Advisories that were resolved from private forks
139
+ (note: publishing is restricted to administrators):
140
140
* Announce the release on the forums and Slack channel
141
141
(note: this forum is restricted to administrators):
142
- * Make a new topic in the "News & Discussion" forums:
143
- https://forum.codeigniter.com/forum-2.html
144
- * The content is somewhat organic, but should include any major features and
145
- changes as well as a link to the User Guide's changelog
142
+ * Make a new topic in the "News & Discussion" forums:
143
+ https://forum.codeigniter.com/forum-2.html
144
+ * The content is somewhat organic, but should include any major features and
145
+ changes as well as a link to the User Guide's changelog
146
+ * Create a PR for new changelog and upgrade for the next version
147
+ * Create **user_guide_src/source/changelogs/{next_version}.rst** and add it to
148
+ **index.rst** (See next-changelog-*.rst)
149
+ * Create **user_guide_src/source/installation/upgrade_{next_version}.rst** and add it to
150
+ **upgrading.rst**
146
151
147
152
## After Publishing Security Advisory
148
153
149
154
* Send a PR to [PHP Security Advisories Database](https://github.com/FriendsOfPHP/security-advisories).
150
- * E.g. https://github.com/FriendsOfPHP/security-advisories/pull/606
151
- * See https://github.com/FriendsOfPHP/security-advisories#contributing
152
- * Don't forget to run ` php -d memory_limit=-1 validator.php ` , before
153
- submitting the PR
155
+ * E.g. https://github.com/FriendsOfPHP/security-advisories/pull/606
156
+ * See https://github.com/FriendsOfPHP/security-advisories#contributing
157
+ * Don't forget to run `php -d memory_limit=-1 validator.php`, before
158
+ submitting the PR
154
159
155
160
## Appendix
156
161
@@ -180,13 +185,13 @@ sudo pip3 install sphinx_rtd_theme
180
185
** ./CodeIgniter4.x.x.epub**
181
186
* Commit the changes with "Update for 4.x.x" and push to origin
182
187
* Create a new PR from ` release-4.x.x ` to ` develop ` :
183
- * Title: "Update for 4.x.x"
184
- * Description: blank
188
+ * Title: "Update for 4.x.x"
189
+ * Description: blank
185
190
* Merge the PR
186
191
* Create a new Release:
187
- * Version: "v4.x.x"
188
- * Title: "CodeIgniter 4.x.x User Guide"
189
- * Description: "CodeIgniter 4.x.x User Guide"
192
+ * Version: "v4.x.x"
193
+ * Title: "CodeIgniter 4.x.x User Guide"
194
+ * Description: "CodeIgniter 4.x.x User Guide"
190
195
* Watch for the "github pages" Environment to make sure the deployment succeeds
191
196
192
197
The User Guide website should update itself via the deploy GitHub Action. Should
0 commit comments