-
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 #7384 from codeigniter4/develop
4.3.3 Ready code
- Loading branch information
Showing
91 changed files
with
1,039 additions
and
382 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
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 |
---|---|---|
|
@@ -16,7 +16,8 @@ If you release a new minor version. | |
|
||
## Changelog | ||
|
||
When generating the changelog each Pull Request to be included must have one of the following [labels](https://github.com/codeigniter4/CodeIgniter4/labels): | ||
When generating the changelog each Pull Request to be included must have one of | ||
the following [labels](https://github.com/codeigniter4/CodeIgniter4/labels): | ||
- **bug** ... PRs that fix bugs | ||
- **enhancement** ... PRs to improve existing functionalities | ||
- **new feature** ... PRs for new features | ||
|
@@ -27,7 +28,8 @@ PRs with breaking changes must have the following additional label: | |
|
||
### Generate Changelog | ||
|
||
To auto-generate, navigate to the [Releases](https://github.com/codeigniter4/CodeIgniter4/releases) page, | ||
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) | ||
|
@@ -39,32 +41,42 @@ Check the resulting content. If there are items in the *Others* section which | |
should be included in the changelog, add a label to the PR and regenerate | ||
the changelog. | ||
|
||
Copy the resulting content into **CHANGELOG.md** and adjust the format to match the existing content. | ||
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 | ||
* Clone both **codeigniter4/CodeIgniter4** and **codeigniter4/userguide** and | ||
resolve any necessary PRs | ||
```console | ||
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*) | ||
* Vet the **admin/** folders for any removed hidden files (Action deploy scripts | ||
*do not remove these*) | ||
* Merge any Security Advisory PRs in private forks | ||
|
||
## Process | ||
|
||
> 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. | ||
> **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. | ||
* Create a new branch `release-4.x.x` | ||
* Update **system/CodeIgniter.php** with the new version number: `const CI_VERSION = '4.x.x';` | ||
* Update **user_guide_src/source/conf.py** with the new `version = '4.x'` (if applicable) and `release = '4.x.x'` | ||
* Update **system/CodeIgniter.php** with the new version number: | ||
`const CI_VERSION = '4.x.x';` | ||
* 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** | ||
* git diff --name-status master -- . ':!system' | ||
* 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** | ||
* git diff --name-status origin/master -- . ':!system' | ||
* 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" | ||
|
@@ -85,9 +97,13 @@ See the changelog: https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHA | |
## New Contributors | ||
* | ||
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: | ||
* 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 | ||
|
@@ -121,22 +137,28 @@ git switch -c 4.x | |
git push origin HEAD | ||
``` | ||
* Publish any Security Advisories that were resolved from private forks | ||
* 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 | ||
* 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 | ||
|
||
## 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 | ||
* Don't forget to run `php -d memory_limit=-1 validator.php`, before | ||
submitting the PR | ||
|
||
## Appendix | ||
|
||
### Sphinx Installation | ||
|
||
You may need to install Sphinx and its dependencies prior to building the User Guide. | ||
You may need to install Sphinx and its dependencies prior to building the User | ||
Guide. | ||
|
||
This worked seamlessly on Ubuntu 20.04: | ||
```console | ||
sudo apt install python3-sphinx | ||
|
@@ -152,8 +174,10 @@ sudo pip3 install sphinx_rtd_theme | |
* Build the ePub version of the User Guide: `make epub` | ||
* Switch to the **userguide** repo and create a new branch `release-4.x.x` | ||
* Replace **docs/** with **CodeIgniter4/user_guide_src/build/html** | ||
* Ensure the file **docs/.nojekyll** exists or GitHub Pages will ignore folders with an underscore prefix | ||
* Copy **CodeIgniter4/user_guide_src/build/epub/CodeIgniter.epub** to **./CodeIgniter4.x.x.epub** | ||
* Ensure the file **docs/.nojekyll** exists or GitHub Pages will ignore folders | ||
with an underscore prefix | ||
* Copy **CodeIgniter4/user_guide_src/build/epub/CodeIgniter.epub** to | ||
**./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" | ||
|
@@ -165,6 +189,6 @@ sudo pip3 install sphinx_rtd_theme | |
* 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 this fail | ||
the server must be updated manually. See repo and hosting details in the deploy script | ||
at the User Guide repo. | ||
The User Guide website should update itself via the deploy GitHub Action. Should | ||
this fail the server must be updated manually. See repo and hosting details in | ||
the deploy script at the User Guide repo. |
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
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
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
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
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
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
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
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
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
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
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
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
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
Oops, something went wrong.