-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9176 from kenjis/update-RELEASE.md
docs: update RELEASE.md
- Loading branch information
Showing
1 changed file
with
26 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,6 +12,9 @@ | |
| - `4.y`: The next minor version. (e.g., `4.6`) | ||
| - `4.z`: The next next minor version. (e.g., `4.7`) | ||
|
|
||
| > [!NOTE] | ||
| > Copy this file, and replace the versions above with the actual versions. | ||
| ## Merge `develop` branch into next minor version branch `4.y` | ||
|
|
||
| Before starting release process, if there are commits in `develop` branch that | ||
|
|
@@ -35,6 +38,26 @@ If you release a new minor version. | |
| "Branch protection rules" to the next minor version. E.g. `4.5` → `4.6` | ||
| * [ ] Delete the merged `4.y` branch (This closes all PRs to the branch) | ||
|
|
||
| ## Preparation | ||
|
|
||
| Work off direct clones of the repos so the release branches persist for a time. | ||
|
|
||
| * [ ] Clone both **codeigniter4/CodeIgniter4** and **codeigniter4/userguide** and | ||
| resolve any necessary PRs | ||
| ```console | ||
| rm -rf CodeIgniter4.bk userguide.bk | ||
| mv CodeIgniter4 CodeIgniter4.bk | ||
| mv userguide userguide.bk | ||
| git clone [email protected]:codeigniter4/CodeIgniter4.git | ||
| git clone [email protected]:codeigniter4/userguide.git | ||
| ``` | ||
| * [ ] Vet the **admin/** folders for any removed hidden files (Action deploy scripts | ||
| *do not remove these*) | ||
| ```console | ||
| cd CodeIgniter4 | ||
| git diff --name-status origin/master admin/ | ||
| ``` | ||
|
|
||
| ## Changelog | ||
|
|
||
| When generating the changelog each Pull Request to be included must have one of | ||
|
|
@@ -65,33 +88,14 @@ the changelog. | |
| Copy the resulting content into **CHANGELOG.md** and adjust the format to match | ||
| the existing content. | ||
|
|
||
| ## Preparation | ||
|
|
||
| Work off direct clones of the repos so the release branches persist for a time. | ||
|
|
||
| * [ ] Clone both **codeigniter4/CodeIgniter4** and **codeigniter4/userguide** and | ||
| resolve any necessary PRs | ||
| ```console | ||
| rm -rf CodeIgniter4.bk userguide.bk | ||
| mv CodeIgniter4 CodeIgniter4.bk | ||
| mv userguide userguide.bk | ||
| git clone [email protected]:codeigniter4/CodeIgniter4.git | ||
| git clone [email protected]:codeigniter4/userguide.git | ||
| ``` | ||
| * [ ] Vet the **admin/** folders for any removed hidden files (Action deploy scripts | ||
| *do not remove these*) | ||
| ```console | ||
| cd CodeIgniter4 | ||
| git diff --name-status origin/master admin/ | ||
| ``` | ||
| * [ ] Merge any Security Advisory PRs in private forks | ||
|
|
||
| ## Process | ||
|
|
||
| > **Note** Most changes that need noting in the User Guide and docs should have | ||
| > [!NOTE] | ||
| > Most changes that need noting in the User Guide and docs should have | ||
| > been included with their PR, so this process assumes you will not be | ||
| > generating much new content. | ||
|
|
||
| * [ ] Merge any Security Advisory PRs in private forks | ||
| * [ ] Replace **CHANGELOG.md** with the new version generated above | ||
| * [ ] Update **user_guide_src/source/changelogs/v4.x.x.rst** | ||
| * Remove the section titles that have no items | ||
|
|
||