Skip to content

Commit ea2b26b

Browse files
committed
docs: update RELEASE.md
1 parent 567a4be commit ea2b26b

File tree

1 file changed

+26
-14
lines changed

1 file changed

+26
-14
lines changed

admin/RELEASE.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> Documentation guide based on the releases of `4.0.5` and `4.1.0` on January 31, 2021.
44
>
5-
> Updated for `4.3.0` on January 10, 2023.
5+
> Updated for `4.4.3` on October 27, 2023.
66
>
77
> -MGatner, kenjis
88
@@ -53,12 +53,18 @@ Work off direct clones of the repos so the release branches persist for a time.
5353
* [ ] Clone both **codeigniter4/CodeIgniter4** and **codeigniter4/userguide** and
5454
resolve any necessary PRs
5555
```console
56+
rm -rf CodeIgniter4.bk userguide.bk
57+
mv CodeIgniter4 CodeIgniter4.bk
58+
mv userguide userguide.bk
5659
git clone [email protected]:codeigniter4/CodeIgniter4.git
5760
git clone [email protected]:codeigniter4/userguide.git
5861
```
5962
* [ ] Vet the **admin/** folders for any removed hidden files (Action deploy scripts
6063
*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+
```
6268
* [ ] Merge any Security Advisory PRs in private forks
6369

6470
## Process
@@ -67,21 +73,24 @@ Work off direct clones of the repos so the release branches persist for a time.
6773
> been included with their PR, so this process assumes you will not be
6874
> generating much new content.
6975
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'`
7576
* [ ] Replace **CHANGELOG.md** with the new version generated above
7677
* [ ] Update **user_guide_src/source/changelogs/{version}.rst**
77-
* Set the date to format `Release Date: January 31, 2021`
7878
* Remove the section titles that have no items
7979
* [ ] Update **user_guide_src/source/installation/upgrade_{ver}.rst**
8080
* fill in the "All Changes" section, and add it to **upgrading.rst**
8181
* git diff --name-status origin/master -- . ':!system'
8282
* Remove the section titles that have no items
8383
* [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`
8594
* [ ] Create a new PR from `release-4.x.x` to `develop`:
8695
* Title: `Prep for 4.x.x release`
8796
* Description:
@@ -119,6 +128,7 @@ Work off direct clones of the repos so the release branches persist for a time.
119128
* [ ] Run the following commands to install and test `appstarter` and verify the new
120129
version:
121130
```console
131+
rm -rf release-test
122132
composer create-project codeigniter4/appstarter release-test
123133
cd release-test
124134
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.
152162
git switch -c 4.x
153163
git push origin HEAD
154164
```
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
156166
(note: publishing is restricted to administrators):
157167
* [ ] Announce the release on the forums and Slack channel
158168
(note: this forum is restricted to administrators):
159169
* Make a new topic in the "News & Discussion" forums:
160170
https://forum.codeigniter.com/forum-2.html
161171
* The content is somewhat organic, but should include any major features and
162172
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**)
163179
* [ ] 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**)
168180
169181
## Appendix
170182

0 commit comments

Comments
 (0)