Skip to content

Commit

Permalink
Merge pull request #9176 from kenjis/update-RELEASE.md
Browse files Browse the repository at this point in the history
docs: update RELEASE.md
  • Loading branch information
kenjis committed Sep 8, 2024
2 parents 268156c + d7bedff commit 0a6b39d
Showing 1 changed file with 26 additions and 22 deletions.
48 changes: 26 additions & 22 deletions admin/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 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
Expand Down Expand Up @@ -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 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/
```
* [ ] 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
Expand Down

0 comments on commit 0a6b39d

Please sign in to comment.