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.2.10 ` on November 5, 2022 .
5+ > Updated for ` 4.3.0 ` on January 10, 2023 .
66>
7- > -MGatner
7+ > -MGatner, kenjis
8+
9+ ## [ Minor version only] Merge minor version branch into develop
10+
11+ If you release a new minor version.
12+
13+ * Create PR to merge ` 4.x ` into ` develop ` and merge it
14+ * Delete the merged ` 4.x ` branch (This closes all PRs to the branch)
15+ * Do the regular release process. Go to the next "Changelog" section
816
917## Changelog
1018
@@ -17,7 +25,20 @@ When generating the changelog each Pull Request to be included must have one of
1725PRs with breaking changes must have the following additional label:
1826- ** breaking change** ... PRs that may break existing functionalities
1927
20- To auto-generate, start drafting a new Release and use the "Generate release notes" button.
28+ ### Generate Changelog
29+
30+ To auto-generate, navigate to the [ Releases] ( https://github.com/codeigniter4/CodeIgniter4/releases ) page,
31+ click the "Draft a new release" button.
32+
33+ * Tag: "v4.x.x" (Create new tag)
34+ * Target: develop
35+
36+ Click the "Generate release notes" button.
37+
38+ Check the resulting content. If there are items in the * Others* section which
39+ should be included in the changelog, add a label to the PR and regenerate
40+ the changelog.
41+
2142Copy the resulting content into ** CHANGELOG.md** and adjust the format to match the existing content.
2243
2344## Preparation
@@ -92,6 +113,13 @@ git merge origin/4.x
92113git merge origin/develop
93114git push origin HEAD
94115```
116+ * [ Minor version only] Create the next minor upgrade branch ` 4.x ` :
117+ ``` console
118+ git fetch origin
119+ git switch develop
120+ git switch -c 4.x
121+ git push origin HEAD
122+ ```
95123* Publish any Security Advisories that were resolved from private forks
96124* Announce the release on the forums and Slack channel (note: this forum is restricted to administrators):
97125 * Make a new topic in the "News & Discussion" forums: https://forum.codeigniter.com/forum-2.html
0 commit comments