2
2
3
3
> Documentation guide based on the releases of ` 4.0.5 ` and ` 4.1.0 ` on January 31, 2021.
4
4
>
5
- > Updated for ` 4.3.0 ` on January 10 , 2023.
5
+ > Updated for ` 4.4.3 ` on October 27 , 2023.
6
6
>
7
7
> -MGatner, kenjis
8
8
@@ -53,12 +53,18 @@ Work off direct clones of the repos so the release branches persist for a time.
53
53
* [ ] Clone both ** codeigniter4/CodeIgniter4** and ** codeigniter4/userguide** and
54
54
resolve any necessary PRs
55
55
``` console
56
+ rm -rf CodeIgniter4.bk userguide.bk
57
+ mv CodeIgniter4 CodeIgniter4.bk
58
+ mv userguide userguide.bk
56
59
git clone [email protected] :codeigniter4/CodeIgniter4.git
57
60
git clone [email protected] :codeigniter4/userguide.git
58
61
```
59
62
* [ ] Vet the **admin/** folders for any removed hidden files (Action deploy scripts
60
63
*do not remove these*)
61
- * git diff --name-status origin/master admin/
64
+ ```console
65
+ cd CodeIgniter4
66
+ git diff --name-status origin/master admin/
67
+ ```
62
68
* [ ] Merge any Security Advisory PRs in private forks
63
69
64
70
## Process
@@ -67,21 +73,24 @@ Work off direct clones of the repos so the release branches persist for a time.
67
73
> been included with their PR, so this process assumes you will not be
68
74
> generating much new content.
69
75
70
- * [ ] Create a new branch `release-4.x.x`
71
- * [ ] Update **system/CodeIgniter.php** with the new version number:
72
- `const CI_VERSION = '4.x.x';`
73
- * [ ] Update **user_guide_src/source/conf.py** with the new `version = '4.x'` (if applicable)
74
- and `release = '4.x.x'`
75
76
* [ ] Replace ** CHANGELOG.md** with the new version generated above
76
77
* [ ] Update ** user_guide_src/source/changelogs/{version}.rst**
77
- * Set the date to format `Release Date: January 31, 2021`
78
78
* Remove the section titles that have no items
79
79
* [ ] Update ** user_guide_src/source/installation/upgrade_ {ver}.rst**
80
80
* fill in the "All Changes" section, and add it to ** upgrading.rst**
81
81
* git diff --name-status origin/master -- . ':!system'
82
82
* Remove the section titles that have no items
83
83
* [ Minor version only] Update the "from" version in the title. E.g., ` from 4.3.x ` → ` from 4.3.8 `
84
- * [ ] Commit the changes with `Prep for 4.x.x release` and push to origin
84
+ * [ ] Run ` php admin/prepare-release.php 4.x.x ` and push to origin
85
+ * The above command does the following:
86
+ * Create a new branch ` release-4.x.x `
87
+ * Update ** system/CodeIgniter.php** with the new version number:
88
+ ` const CI_VERSION = '4.x.x'; `
89
+ * Update ** user_guide_src/source/conf.py** with the new ` version = '4.x' ` (if applicable)
90
+ and ` release = '4.x.x' `
91
+ * Update ** user_guide_src/source/changelogs/{version}.rst**
92
+ * Set the date to format ` Release Date: January 31, 2021 `
93
+ * Commit the changes with ` Prep for 4.x.x release `
85
94
* [ ] Create a new PR from ` release-4.x.x ` to ` develop ` :
86
95
* Title: ` Prep for 4.x.x release `
87
96
* Description:
@@ -119,6 +128,7 @@ Work off direct clones of the repos so the release branches persist for a time.
119
128
* [ ] Run the following commands to install and test `appstarter` and verify the new
120
129
version:
121
130
```console
131
+ rm -rf release-test
122
132
composer create-project codeigniter4/appstarter release-test
123
133
cd release-test
124
134
composer test && composer info codeigniter4/framework
@@ -152,19 +162,21 @@ Work off direct clones of the repos so the release branches persist for a time.
152
162
git switch -c 4.x
153
163
git push origin HEAD
154
164
```
155
- * [ ] Publish any Security Advisories that were resolved from private forks
165
+ * [ ] Request CVEs and Publish any Security Advisories that were resolved from private forks
156
166
(note: publishing is restricted to administrators):
157
167
* [ ] Announce the release on the forums and Slack channel
158
168
(note: this forum is restricted to administrators):
159
169
* Make a new topic in the "News & Discussion" forums:
160
170
https://forum.codeigniter.com/forum-2.html
161
171
* The content is somewhat organic, but should include any major features and
162
172
changes as well as a link to the User Guide's changelog
173
+ * [ ] Run `php admin/create-new-changelog.php <current_version> <new_version>`
174
+ * The above command does the following:
175
+ * Create **user_guide_src/source/changelogs/{next_version}.rst** and add it to
176
+ **index.rst** (See **next-changelog-*.rst**)
177
+ * Create **user_guide_src/source/installation/upgrade_{next_version}.rst** and add it to
178
+ **upgrading.rst** (See **next-upgrading-guide.rst**)
163
179
* [ ] Create a PR for new changelog and upgrade for the next version
164
- * Create **user_guide_src/source/changelogs/{next_version}.rst** and add it to
165
- **index.rst** (See **next-changelog-*.rst**)
166
- * Create **user_guide_src/source/installation/upgrade_{next_version}.rst** and add it to
167
- **upgrading.rst** (See **next-upgrading-guide.rst**)
168
180
169
181
## Appendix
170
182
0 commit comments