From ee9ae5fbb34c411fb765153f1877a0348ac51063 Mon Sep 17 00:00:00 2001 From: kenjis Date: Sat, 7 Sep 2024 18:09:27 +0900 Subject: [PATCH 1/4] docs: add note --- admin/RELEASE.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/admin/RELEASE.md b/admin/RELEASE.md index 4f199a821177..6e0b812b25a7 100644 --- a/admin/RELEASE.md +++ b/admin/RELEASE.md @@ -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 From 2492078509c7738818a2be05319f181ff58cf30b Mon Sep 17 00:00:00 2001 From: kenjis Date: Sat, 7 Sep 2024 18:09:59 +0900 Subject: [PATCH 2/4] docs: move item --- admin/RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/admin/RELEASE.md b/admin/RELEASE.md index 6e0b812b25a7..61667d612178 100644 --- a/admin/RELEASE.md +++ b/admin/RELEASE.md @@ -87,7 +87,6 @@ Work off direct clones of the repos so the release branches persist for a time. cd CodeIgniter4 git diff --name-status origin/master admin/ ``` -* [ ] Merge any Security Advisory PRs in private forks ## Process @@ -95,6 +94,7 @@ Work off direct clones of the repos so the release branches persist for a time. > 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 From cb4ba98ce6c294662e9bcc8d6c27f3ac15288f8b Mon Sep 17 00:00:00 2001 From: kenjis Date: Sat, 7 Sep 2024 18:10:37 +0900 Subject: [PATCH 3/4] docs: move section --- admin/RELEASE.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/admin/RELEASE.md b/admin/RELEASE.md index 61667d612178..30b1f77b7362 100644 --- a/admin/RELEASE.md +++ b/admin/RELEASE.md @@ -38,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 git@github.com:codeigniter4/CodeIgniter4.git + git clone git@github.com: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 @@ -68,26 +88,6 @@ 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 git@github.com:codeigniter4/CodeIgniter4.git - git clone git@github.com: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/ - ``` - ## Process > **Note** Most changes that need noting in the User Guide and docs should have From d7bedff4e71c0b4d76888238b13ae369789ecd37 Mon Sep 17 00:00:00 2001 From: kenjis Date: Sat, 7 Sep 2024 18:10:53 +0900 Subject: [PATCH 4/4] docs: use GitHub markdown note format --- admin/RELEASE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/admin/RELEASE.md b/admin/RELEASE.md index 30b1f77b7362..9ed91e55c183 100644 --- a/admin/RELEASE.md +++ b/admin/RELEASE.md @@ -90,7 +90,8 @@ the existing content. ## 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.