Merge pull request #7385 from kenjis/update-RELEASE.md

docs: update admin/RELEASE.md

Author: kenjis

admin/RELEASE.md

@@ -32,8 +32,8 @@ To auto-generate, navigate to the
 [Releases](https://github.com/codeigniter4/CodeIgniter4/releases) page,
 click the "Draft a new release" button.
 
-* Tag: "v4.x.x" (Create new tag)
-* Target: develop
+* Tag: `v4.x.x` (Create new tag)
+* Target: `develop`
 
 Click the "Generate release notes" button.
 
@@ -49,10 +49,10 @@ the existing content.
 * 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
-git clone git@github.com:codeigniter4/CodeIgniter4.git
-git clone git@github.com:codeigniter4/userguide.git
-```
+    ```console
+    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*)
 * Merge any Security Advisory PRs in private forks
@@ -69,88 +69,93 @@ git clone git@github.com:codeigniter4/userguide.git
 * Update **user_guide_src/source/conf.py** with the new `version = '4.x'` (if applicable)
   and `release = '4.x.x'`
 * Replace **CHANGELOG.md** with the new version generated above
-* Set the date in **user_guide_src/source/changelogs/{version}.rst** to format
-  `Release Date: January 31, 2021`
-* Create a new changelog for the next version at
-  **user_guide_src/source/changelogs/{next_version}.rst** and add it to
-  **index.rst**
-* Create **user_guide_src/source/installation/upgrade_{ver}.rst**, fill in the
-  "All Changes" section, and add it to **upgrading.rst**
+* Update **user_guide_src/source/changelogs/{version}.rst**
+  * Set the date to format `Release Date: January 31, 2021`
+  * Remove the section titles that have no items
+* Update **user_guide_src/source/installation/upgrade_{ver}.rst**
+  * fill in the "All Changes" section, and add it to **upgrading.rst**
     * git diff --name-status origin/master -- . ':!system'
-* Commit the changes with "Prep for 4.x.x release" and push to origin
+  * Remove the section titles that have no items
+* Commit the changes with `Prep for 4.x.x release` and push to origin
 * Create a new PR from `release-4.x.x` to `develop`:
-    * Title: "Prep for 4.x.x release"
-    * Decription: "Updates changelog and version references for `4.x.x`." (plus checklist)
+  * Title: `Prep for 4.x.x release`
+  * Decription: `Updates changelog and version references for 4.x.x.` (plus checklist)
 * Let all tests run, then review and merge the PR
 * Create a new PR from `develop` to `master`:
-    * Title: "4.x.x Ready code"
-    * Description: blank
+  * Title: `4.x.x Ready code`
+  * Description: blank
 * Merge the PR then create a new Release:
-    * Version: "v4.x.x"
-    * Target: master
-    * Title: "CodeIgniter 4.x.x"
-    * Description:
-```
-CodeIgniter 4.x.x release.
+  * Version: `v4.x.x`
+  * Target: `master`
+  * Title: `CodeIgniter 4.x.x`
+  * Description:
+    ```
+    CodeIgniter 4.x.x release.
 
-See the changelog: https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md
+    See the changelog: https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md
 
-## New Contributors
-*
+    ## New Contributors
+    *
 
-Full Changelog: https://github.com/codeigniter4/CodeIgniter4/compare/v4.x.x...v4.x.x
-```
+    Full Changelog: https://github.com/codeigniter4/CodeIgniter4/compare/v4.x.x...v4.x.x
+    ```
 * Watch for the "Deploy Distributable Repos" action to make sure **framework**,
   **appstarter**, and **userguide** get updated
 * Run the following commands to install and test `appstarter` and verify the new
   version:
-```console
-composer create-project codeigniter4/appstarter release-test
-cd release-test
-composer test && composer info codeigniter4/framework
-```
+    ```console
+    composer create-project codeigniter4/appstarter release-test
+    cd release-test
+    composer test && composer info codeigniter4/framework
+    ```
 * Verify that the user guide actions succeeded:
-    * "[Deploy Distributable Repos](https://github.com/codeigniter4/CodeIgniter4/actions/workflows/deploy-distributables.yml)", the main repo
-    * "[Deploy Production](https://github.com/codeigniter4/userguide/actions/workflows/deploy.yml)", UG repo
-    * "[pages-build-deployment](https://github.com/codeigniter4/userguide/actions/workflows/pages/pages-build-deployment)", UG repo
+  * "[Deploy Distributable Repos](https://github.com/codeigniter4/CodeIgniter4/actions/workflows/deploy-distributables.yml)", the main repo
+  * "[Deploy Production](https://github.com/codeigniter4/userguide/actions/workflows/deploy.yml)", UG repo
+  * "[pages-build-deployment](https://github.com/codeigniter4/userguide/actions/workflows/pages/pages-build-deployment)", UG repo
 * Fast-forward `develop` branch to catch the merge commit from `master`
-```console
-git fetch origin
-git checkout develop
-git merge origin/develop
-git merge origin/master
-git push origin HEAD
-```
+    ```console
+    git fetch origin
+    git checkout develop
+    git merge origin/develop
+    git merge origin/master
+    git push origin HEAD
+    ```
 * Update the next minor upgrade branch `4.x`:
-```console
-git fetch origin
-git checkout 4.x
-git merge origin/4.x
-git merge origin/develop
-git push origin HEAD
-```
+    ```console
+    git fetch origin
+    git checkout 4.x
+    git merge origin/4.x
+    git merge origin/develop
+    git push origin HEAD
+    ```
 * [Minor version only] Create the next minor upgrade branch `4.x`:
-```console
-git fetch origin
-git switch develop
-git switch -c 4.x
-git push origin HEAD
-```
+    ```console
+    git fetch origin
+    git switch develop
+    git switch -c 4.x
+    git push origin HEAD
+    ```
 * Publish any Security Advisories that were resolved from private forks
+  (note: publishing is restricted to administrators):
 * Announce the release on the forums and Slack channel
   (note: this forum is restricted to administrators):
-    * Make a new topic in the "News & Discussion" forums:
-      https://forum.codeigniter.com/forum-2.html
-    * The content is somewhat organic, but should include any major features and
-      changes as well as a link to the User Guide's changelog
+  * Make a new topic in the "News & Discussion" forums:
+    https://forum.codeigniter.com/forum-2.html
+  * The content is somewhat organic, but should include any major features and
+    changes as well as a link to the User Guide's changelog
+* Create a PR for new changelog and upgrade for the next version
+  * Create **user_guide_src/source/changelogs/{next_version}.rst** and add it to
+    **index.rst** (See next-changelog-*.rst)
+  * Create **user_guide_src/source/installation/upgrade_{next_version}.rst** and add it to
+    **upgrading.rst**
 
 ## After Publishing Security Advisory
 
 * Send a PR to [PHP Security Advisories Database](https://github.com/FriendsOfPHP/security-advisories).
-    * E.g. https://github.com/FriendsOfPHP/security-advisories/pull/606
-    * See https://github.com/FriendsOfPHP/security-advisories#contributing
-    * Don't forget to run `php -d memory_limit=-1 validator.php`, before
-      submitting the PR
+  * E.g. https://github.com/FriendsOfPHP/security-advisories/pull/606
+  * See https://github.com/FriendsOfPHP/security-advisories#contributing
+  * Don't forget to run `php -d memory_limit=-1 validator.php`, before
+    submitting the PR
 
 ## Appendix
 
@@ -180,13 +185,13 @@ sudo pip3 install sphinx_rtd_theme
   **./CodeIgniter4.x.x.epub**
 * Commit the changes with "Update for 4.x.x" and push to origin
 * Create a new PR from `release-4.x.x` to `develop`:
-    * Title: "Update for 4.x.x"
-    * Description: blank
+  * Title: "Update for 4.x.x"
+  * Description: blank
 * Merge the PR
 * Create a new Release:
-    * Version: "v4.x.x"
-    * Title: "CodeIgniter 4.x.x User Guide"
-    * Description: "CodeIgniter 4.x.x User Guide"
+  * Version: "v4.x.x"
+  * Title: "CodeIgniter 4.x.x User Guide"
+  * Description: "CodeIgniter 4.x.x User Guide"
 * Watch for the "github pages" Environment to make sure the deployment succeeds
 
 The User Guide website should update itself via the deploy GitHub Action. Should