Skip to content

Commit 0a6b39d

Browse files
authored
Merge pull request #9176 from kenjis/update-RELEASE.md
docs: update RELEASE.md
2 parents 268156c + d7bedff commit 0a6b39d

File tree

1 file changed

+26
-22
lines changed

1 file changed

+26
-22
lines changed

admin/RELEASE.md

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212
- `4.y`: The next minor version. (e.g., `4.6`)
1313
- `4.z`: The next next minor version. (e.g., `4.7`)
1414

15+
> [!NOTE]
16+
> Copy this file, and replace the versions above with the actual versions.
17+
1518
## Merge `develop` branch into next minor version branch `4.y`
1619

1720
Before starting release process, if there are commits in `develop` branch that
@@ -35,6 +38,26 @@ If you release a new minor version.
3538
"Branch protection rules" to the next minor version. E.g. `4.5``4.6`
3639
* [ ] Delete the merged `4.y` branch (This closes all PRs to the branch)
3740

41+
## Preparation
42+
43+
Work off direct clones of the repos so the release branches persist for a time.
44+
45+
* [ ] Clone both **codeigniter4/CodeIgniter4** and **codeigniter4/userguide** and
46+
resolve any necessary PRs
47+
```console
48+
rm -rf CodeIgniter4.bk userguide.bk
49+
mv CodeIgniter4 CodeIgniter4.bk
50+
mv userguide userguide.bk
51+
git clone [email protected]:codeigniter4/CodeIgniter4.git
52+
git clone [email protected]:codeigniter4/userguide.git
53+
```
54+
* [ ] Vet the **admin/** folders for any removed hidden files (Action deploy scripts
55+
*do not remove these*)
56+
```console
57+
cd CodeIgniter4
58+
git diff --name-status origin/master admin/
59+
```
60+
3861
## Changelog
3962

4063
When generating the changelog each Pull Request to be included must have one of
@@ -65,33 +88,14 @@ the changelog.
6588
Copy the resulting content into **CHANGELOG.md** and adjust the format to match
6689
the existing content.
6790

68-
## Preparation
69-
70-
Work off direct clones of the repos so the release branches persist for a time.
71-
72-
* [ ] Clone both **codeigniter4/CodeIgniter4** and **codeigniter4/userguide** and
73-
resolve any necessary PRs
74-
```console
75-
rm -rf CodeIgniter4.bk userguide.bk
76-
mv CodeIgniter4 CodeIgniter4.bk
77-
mv userguide userguide.bk
78-
git clone [email protected]:codeigniter4/CodeIgniter4.git
79-
git clone [email protected]:codeigniter4/userguide.git
80-
```
81-
* [ ] Vet the **admin/** folders for any removed hidden files (Action deploy scripts
82-
*do not remove these*)
83-
```console
84-
cd CodeIgniter4
85-
git diff --name-status origin/master admin/
86-
```
87-
* [ ] Merge any Security Advisory PRs in private forks
88-
8991
## Process
9092

91-
> **Note** Most changes that need noting in the User Guide and docs should have
93+
> [!NOTE]
94+
> Most changes that need noting in the User Guide and docs should have
9295
> been included with their PR, so this process assumes you will not be
9396
> generating much new content.
9497
98+
* [ ] Merge any Security Advisory PRs in private forks
9599
* [ ] Replace **CHANGELOG.md** with the new version generated above
96100
* [ ] Update **user_guide_src/source/changelogs/v4.x.x.rst**
97101
* Remove the section titles that have no items

0 commit comments

Comments
 (0)