Skip to content

Commit b102b3e

Browse files
committed
Merge remote-tracking branch 'upstream/develop' into 4.6
Conflicts: user_guide_src/source/changelogs/index.rst user_guide_src/source/installation/upgrading.rst
2 parents 4722157 + 62c48ac commit b102b3e

File tree

9 files changed

+133
-27
lines changed

9 files changed

+133
-27
lines changed

admin/RELEASE.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,22 @@
66
>
77
> -MGatner, kenjis
88
9-
## Merge `develop` branch into next minor version branch `4.x`
9+
## Notation
10+
11+
- `4.x.x`: The new release version. (e.g., `4.5.3`)
12+
- `4.y`: The next minor version. (e.g., `4.6`)
13+
- `4.z`: The next next minor version. (e.g., `4.7`)
14+
15+
## Merge `develop` branch into next minor version branch `4.y`
1016

1117
Before starting release process, if there are commits in `develop` branch that
12-
are not merged into `4.x` branch, merge them. This is because if conflicts occur,
18+
are not merged into `4.y` branch, merge them. This is because if conflicts occur,
1319
merging will take time.
1420

1521
```console
1622
git fetch upstream
17-
git switch 4.x
18-
git merge upstream/4.x
23+
git switch 4.y
24+
git merge upstream/4.y
1925
git merge upstream/develop
2026
git push upstream HEAD
2127
```
@@ -24,11 +30,10 @@ git push upstream HEAD
2430

2531
If you release a new minor version.
2632

27-
* [ ] Create PR to merge `4.x` into `develop` and merge it
33+
* [ ] Create PR to merge `4.y` into `develop` and merge it
2834
* [ ] Rename the current minor version (e.g., `4.5`) in Setting > Branches >
2935
"Branch protection rules" to the next minor version. E.g. `4.5``4.6`
30-
* [ ] Delete the merged `4.x` branch (This closes all PRs to the branch)
31-
* Do the regular release process. Go to the next "Changelog" section
36+
* [ ] Delete the merged `4.y` branch (This closes all PRs to the branch)
3237

3338
## Changelog
3439

@@ -90,8 +95,8 @@ Work off direct clones of the repos so the release branches persist for a time.
9095
* [ ] Replace **CHANGELOG.md** with the new version generated above
9196
* [ ] Update **user_guide_src/source/changelogs/v4.x.x.rst**
9297
* Remove the section titles that have no items
93-
* [ ] Update **user_guide_src/source/installation/upgrade_{ver}.rst**
94-
* [ ] fill in the "All Changes" section, and add it to **upgrading.rst**
98+
* [ ] Update **user_guide_src/source/installation/upgrade_4xx.rst**
99+
* [ ] fill in the "All Changes" section, and add it to **upgrade_4xx.rst**
95100
* git diff --name-status origin/master -- . ':!system' ':!tests' ':!user_guide_src'
96101
* Note: `tests/` is not used for distribution repos. See `admin/starter/tests/`
97102
* [ ] Remove the section titles that have no items
@@ -137,7 +142,7 @@ Work off direct clones of the repos so the release branches persist for a time.
137142
## New Contributors
138143
*
139144
140-
**Full Changelog**: https://github.com/codeigniter4/CodeIgniter4/compare/v4.x.x...v4.x.x
145+
**Full Changelog**: https://github.com/codeigniter4/CodeIgniter4/compare/v4.x.w...v4.x.x
141146
```
142147
Click the "Generate release notes" button, and get the "New Contributors".
143148
* [ ] Watch for the "Deploy Distributable Repos" action to make sure **framework**,
@@ -164,19 +169,19 @@ Work off direct clones of the repos so the release branches persist for a time.
164169
git merge origin/master
165170
git push origin HEAD
166171
```
167-
* [ ] Update the next minor version branch `4.x`:
172+
* [ ] Update the next minor version branch `4.y`:
168173
```console
169174
git fetch origin
170-
git checkout 4.x
171-
git merge origin/4.x
175+
git checkout 4.y
176+
git merge origin/4.y
172177
git merge origin/develop
173178
git push origin HEAD
174179
```
175-
* [ ] [Minor version only] Create the new next minor version branch `4.x`:
180+
* [ ] [Minor version only] Create the new next minor version branch `4.z`:
176181
```console
177182
git fetch origin
178183
git switch develop
179-
git switch -c 4.x
184+
git switch -c 4.z
180185
git push origin HEAD
181186
```
182187
* [ ] Request CVEs and Publish any Security Advisories that were resolved from private forks

admin/starter/composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"autoload": {
2222
"psr-4": {
2323
"App\\": "app/",
24-
"Config\\": "app/Config"
24+
"Config\\": "app/Config/"
2525
},
2626
"exclude-from-classmap": [
2727
"**/Database/Migrations/**"

user_guide_src/source/changelogs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ See all the changes.
1313
:titlesonly:
1414

1515
v4.6.0
16+
v4.5.4
1617
v4.5.3
1718
v4.5.2
1819
v4.5.1
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
#############
2+
Version 4.5.4
3+
#############
4+
5+
Release Date: Unreleased
6+
7+
**4.5.4 release of CodeIgniter4**
8+
9+
.. contents::
10+
:local:
11+
:depth: 3
12+
13+
********
14+
BREAKING
15+
********
16+
17+
***************
18+
Message Changes
19+
***************
20+
21+
*******
22+
Changes
23+
*******
24+
25+
************
26+
Deprecations
27+
************
28+
29+
**********
30+
Bugs Fixed
31+
**********
32+
33+
See the repo's
34+
`CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_
35+
for a complete list of bugs fixed.

user_guide_src/source/incoming/filters.rst

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Configuring Filters
8282
There are two ways to configure filters when they get run. One is done in
8383
**app/Config/Filters.php**, the other is done in **app/Config/Routes.php**.
8484

85-
If you want to specify filter to a specific route, use **app/Config/Routes.php**
85+
If you want to specify filters to defined routes, use **app/Config/Routes.php**
8686
and see :ref:`URI Routing <applying-filters>`.
8787

8888
.. Note:: The safest way to apply filters is to :ref:`disable auto-routing <use-defined-routes-only>`, and :ref:`set filters to routes <applying-filters>`.
@@ -95,9 +95,11 @@ configure exactly when the filters run.
9595

9696
.. Warning:: It is recommended that you should always add ``*`` at the end of a URI in the filter settings.
9797
Because a controller method might be accessible by different URLs than you think.
98-
For example, when :ref:`auto-routing-legacy` is enabled, if you have ``Blog::index``,
98+
For example, when :ref:`auto-routing-legacy` is enabled, if you have ``Blog::index()``,
9999
it can be accessible with ``blog``, ``blog/index``, and ``blog/index/1``, etc.
100100

101+
.. _filters-aliases:
102+
101103
$aliases
102104
--------
103105

@@ -106,7 +108,9 @@ filters to run:
106108

107109
.. literalinclude:: filters/003.php
108110

109-
Aliases are mandatory and if you try to use a full class name later, the system will throw an error. Defining them
111+
Aliases are mandatory and if you try to use a full class name later, the system will throw an error.
112+
113+
Defining them
110114
in this way makes it simple to switch out the class used. Great for when you decided you need to change to a
111115
different authentication system since you only change the filter's class and you're done.
112116

@@ -170,7 +174,7 @@ an array with the ``except`` key and a URI path (relative to BaseURL) to match a
170174
and the URI paths specified in the filter could be different.
171175
See :ref:`upgrade-447-filter-paths` for details.
172176

173-
Any place you can use a URI path (relative to BaseURL) in the filter settings, you can use a regular expression or, like in this example, use
177+
Any place you can use a URI path (relative to BaseURL) in the filter settings, you can use a regular expression or, like in this example above, use
174178
an asterisk (``*``) for a wildcard that will match all characters after that. In this example, any URI path starting with ``api/``
175179
would be exempted from CSRF protection, but the site's forms would all be protected.
176180

@@ -186,17 +190,19 @@ $methods
186190
because :ref:`auto-routing-legacy` permits any HTTP method to access a controller.
187191
Accessing the controller with a method you don't expect could bypass the filter.
188192

189-
You can apply filters to all requests of a certain HTTP method, like POST, GET, PUT, etc. In this array, you would
190-
specify the method name in **lowercase**. It's value would be an array of filters to run:
193+
You can apply filters to all requests of a certain HTTP method, like ``POST``, ``GET``, ``PUT``, etc.
194+
It's value would be an array of filters to run:
191195

192196
.. literalinclude:: filters/008.php
193197

194198
.. note:: Unlike the ``$globals`` or the
195199
``$filters`` properties, these will only run as before filters.
196200

197-
In addition to the standard HTTP methods, this also supports one special case: ``cli``. The ``cli`` method would apply to
201+
In addition to the standard HTTP methods, this also supports one special case: ``CLI``. The ``CLI`` method would apply to
198202
all requests that were run from the command line.
199203

204+
.. note:: Prior to v4.5.0, due to a bug, you needed to specify the HTTP method names in **lowercase**.
205+
200206
$filters
201207
--------
202208

user_guide_src/source/incoming/routing.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -388,12 +388,13 @@ Applying Filters
388388
================
389389

390390
You can alter the behavior of specific routes by supplying filters to run before or after the controller. This is especially handy during authentication or api logging.
391+
391392
The value for the filter can be a string or an array of strings:
392393

393394
* matching the aliases defined in **app/Config/Filters.php**.
394395
* filter classnames
395396

396-
See :doc:`Controller Filters <filters>` for more information on setting up filters.
397+
See :ref:`Controller Filters <filters-aliases>` for more information on defining aliases.
397398

398399
.. Warning:: If you set filters to routes in **app/Config/Routes.php**
399400
(not in **app/Config/Filters.php**), it is recommended to disable Auto Routing (Legacy).
@@ -405,7 +406,7 @@ See :doc:`Controller Filters <filters>` for more information on setting up filte
405406
Alias Filter
406407
------------
407408

408-
You specify an alias defined in **app/Config/Filters.php** for the filter value:
409+
You specify an alias :ref:`defined in app/Config/Filters.php <filters-aliases>` for the filter value:
409410

410411
.. literalinclude:: routing/034.php
411412

@@ -418,7 +419,7 @@ Classname Filter
418419

419420
.. versionadded:: 4.1.5
420421

421-
You specify a filter classname for the filter value:
422+
You can specify a filter classname for the filter value:
422423

423424
.. literalinclude:: routing/036.php
424425

@@ -435,7 +436,7 @@ Multiple Filters
435436
:ref:`Upgrading from 4.1.4 to 4.1.5 <upgrade-415-multiple-filters-for-a-route>`
436437
for the details.
437438

438-
You specify an array for the filter value:
439+
You can specify an array for the filter value:
439440

440441
.. literalinclude:: routing/037.php
441442

user_guide_src/source/installation/upgrade_420.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIO
4343
composer.json
4444
=============
4545

46+
.. note:: This procedure is not required in v4.5.0 or later.
47+
4648
If you use Composer, when you installed CodeIgniter v4.1.9 or before, and
4749
if there are ``App\\`` and ``Config\\`` namespaces in your ``/composer.json``'s ``autoload.psr-4``
4850
like the following, you need to remove these lines, and run ``composer dump-autoload``.
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
#############################
2+
Upgrading from 4.5.3 to 4.5.4
3+
#############################
4+
5+
Please refer to the upgrade instructions corresponding to your installation method.
6+
7+
- :ref:`Composer Installation App Starter Upgrading <app-starter-upgrading>`
8+
- :ref:`Composer Installation Adding CodeIgniter4 to an Existing Project Upgrading <adding-codeigniter4-upgrading>`
9+
- :ref:`Manual Installation Upgrading <installing-manual-upgrading>`
10+
11+
.. contents::
12+
:local:
13+
:depth: 2
14+
15+
**********************
16+
Mandatory File Changes
17+
**********************
18+
19+
****************
20+
Breaking Changes
21+
****************
22+
23+
*********************
24+
Breaking Enhancements
25+
*********************
26+
27+
*************
28+
Project Files
29+
*************
30+
31+
Some files in the **project space** (root, app, public, writable) received updates. Due to
32+
these files being outside of the **system** scope they will not be changed without your intervention.
33+
34+
.. note:: There are some third-party CodeIgniter modules available to assist
35+
with merging changes to the project space:
36+
`Explore on Packagist <https://packagist.org/explore/?query=codeigniter4%20updates>`_.
37+
38+
Content Changes
39+
===============
40+
41+
The following files received significant changes (including deprecations or visual adjustments)
42+
and it is recommended that you merge the updated versions with your application:
43+
44+
Config
45+
------
46+
47+
- @TODO
48+
49+
All Changes
50+
===========
51+
52+
This is a list of all files in the **project space** that received changes;
53+
many will be simple comments or formatting that have no effect on the runtime:
54+
55+
- @TODO

user_guide_src/source/installation/upgrading.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ See also :doc:`./backward_compatibility_notes`.
1717
backward_compatibility_notes
1818

1919
upgrade_460
20+
upgrade_454
2021
upgrade_453
2122
upgrade_452
2223
upgrade_451

0 commit comments

Comments
 (0)