Skip to content

Commit fe31333

Browse files
MGatnerMGatner
authored
Merge pull request #4700 from codeigniter4/release-4.1.2
Prep for 4.1.2 release
2 parents e09b644 + 598c115 commit fe31333

File tree

9 files changed

+455
-9
lines changed

9 files changed

+455
-9
lines changed

‎CHANGELOG.md‎

Lines changed: 270 additions & 2 deletions
Large diffs are not rendered by default.

‎admin/RELEASE.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
# Release Process
22

3-
> Documentation guide based on the releases of `4.0.5` and `4.1.0` on January 31, 2021
3+
> Documentation guide based on the releases of `4.0.5` and `4.1.0` on January 31, 2021.
4+
> Updated for `4.1.2` on May 17, 2021.
45
> -MGatner
56
67
## Preparation
78

89
* Work off direct clones of the repos so the release branches persist for a time
910
* Clone both **codeigniter4/CodeIgniter4** and **codeigniter4/userguide** and resolve any necessary PRs
10-
* Generate a new **CHANGELOG.md** ahead of time using [GitHub Changelog Generator](https://github.com/github-changelog-generator/github-changelog-generator)
11-
* The Action deploy scripts *do not remove hidden files* (e.g. if you delete **.gitattributes**)! Vet the **admin/** folders for issues ahead of time
11+
* Vet the **admin/** folders for any removed hidden files (Action deploy scripts *do not remove these*)
12+
* Generate a new **CHANGELOG.md** ahead of time using [GitHub Changelog Generator](https://github.com/github-changelog-generator/github-changelog-generator):
13+
```
14+
github_changelog_generator --user codeigniter4 --project codeigniter4 --since-tag v4.0.4 --future-release v4.0.5 --token {your_github_token}
15+
...or
16+
github_changelog_generator --user codeigniter4 --project codeigniter4 --since-commit "2021-02-01 13:26:28" --future-release v4.0.5 --token {your_github_token}
17+
```
1218

1319
## CodeIgniter4
1420

‎system/CodeIgniter.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class CodeIgniter
4444
/**
4545
* The current version of CodeIgniter Framework
4646
*/
47-
const CI_VERSION = '4.1.1';
47+
const CI_VERSION = '4.1.2';
4848

4949
/**
5050
* @var string

‎user_guide_src/source/changelogs/index.rst‎

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

15+
v4.1.3
1516
v4.1.2
1617
v4.1.1
1718
v4.1.0

‎user_guide_src/source/changelogs/v4.1.2.rst‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Version 4.1.2
22
=============
33

4-
Release Date: Not released
4+
Release Date: May 16, 2021
55

66
**4.1.2 release of CodeIgniter4**
77

@@ -52,8 +52,9 @@ Deprecations:
5252
- Deprecated ``Time::instance()``, use ``Time::createFromInstance()`` instead (now accepts ``DateTimeInterface``).
5353
- Deprecated ``IncomingRequest::removeRelativeDirectory()``, use ``URI::removeDotSegments()`` instead
5454
- Deprecated ``\API\ResponseTrait::failValidationError`` to use ``\API\ResponseTrait::failValidationErrors`` instead
55-
- Deprecated ``BaseModel::idValue()`` in favor of public ``BaseModel::getIdValue()``. ``BaseModel::getIdValue()`` will be defined as abstract in future any custom Model classes should be updated.
5655

5756
Bugs Fixed:
5857

58+
*See the repo's **CHANGELOG.MD** for a complete list of bugs fixed.*
59+
5960
- ``BaseConnection::query()`` now returns ``false`` for failed queries (unless ``DBDebug==true``, in which case an exception will be thrown) and returns boolean values for write-type queries as specified in the docs.

‎user_guide_src/source/changelogs/v4.1.3.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Version 4.1.3
2+
=============
3+
4+
Release Date: Not released
5+
6+
**4.1.3 release of CodeIgniter4**

‎user_guide_src/source/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
version = '4.1'
2525

2626
# The full version, including alpha/beta/rc tags.
27-
release = '4.1.1'
27+
release = '4.1.2'
2828

2929
# -- General configuration ---------------------------------------------------
3030

‎user_guide_src/source/installation/upgrade_405.rst‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,85 @@ which you may use, and ``DownloadResponse`` now extends ``Response`` directly to
6262

6363
Service discovery has been updated to allow third-party services (when enabled via Modules) to take precedence over core services. Update
6464
**app/Config/Services.php** so the class extends ``CodeIgniter\Config\BaseService`` to allow proper discovery of third-party services.
65+
66+
Project Files
67+
=============
68+
69+
Numerous files in the project space (root, app, public, writable) received updates. Due to
70+
these files being outside of the system scope they will not be changed without your intervention.
71+
There are some third-party CodeIgniter modules available to assist with merging changes to
72+
the project space: `Explore on Packagist <https://packagist.org/explore/?query=codeigniter4%20updates>`_.
73+
74+
.. note:: Except in very rare cases for bug fixes, no changes made to files for the project space
75+
will break your application. All changes noted here are optional until the next major version,
76+
and any mandatory changes will be covered in the sections above.
77+
78+
Content Changes
79+
---------------
80+
81+
The following files received significant changes (including deprecations or visual adjustments)
82+
and it is recommended that you merge the updated versions with your application:
83+
84+
* ``app/Views/*``
85+
* ``public/index.php``
86+
* ``public/.htaccess``
87+
* ``spark``
88+
* ``phpunit.xml.dist``
89+
* ``composer.json``
90+
91+
All Changes
92+
-----------
93+
94+
This is a list of all files in the project space that received changes;
95+
many will be simple comments or formatting that have no affect on the runtime:
96+
97+
* ``LICENSE``
98+
* ``README.md``
99+
* ``app/Config/App.php``
100+
* ``app/Config/Autoload.php``
101+
* ``app/Config/Boot/development.php``
102+
* ``app/Config/Boot/production.php``
103+
* ``app/Config/Boot/testing.php``
104+
* ``app/Config/Cache.php``
105+
* ``app/Config/Constants.php``
106+
* ``app/Config/ContentSecurityPolicy.php``
107+
* ``app/Config/Database.php``
108+
* ``app/Config/DocTypes.php``
109+
* ``app/Config/Email.php``
110+
* ``app/Config/Encryption.php``
111+
* ``app/Config/Events.php``
112+
* ``app/Config/Exceptions.php``
113+
* ``app/Config/Filters.php``
114+
* ``app/Config/ForeignCharacters.php``
115+
* ``app/Config/Format.php``
116+
* ``app/Config/Generators.php``
117+
* ``app/Config/Honeypot.php``
118+
* ``app/Config/Images.php``
119+
* ``app/Config/Kint.php``
120+
* ``app/Config/Logger.php``
121+
* ``app/Config/Migrations.php``
122+
* ``app/Config/Mimes.php``
123+
* ``app/Config/Modules.php``
124+
* ``app/Config/Pager.php``
125+
* ``app/Config/Paths.php``
126+
* ``app/Config/Routes.php``
127+
* ``app/Config/Security.php``
128+
* ``app/Config/Services.php``
129+
* ``app/Config/Toolbar.php``
130+
* ``app/Config/UserAgents.php``
131+
* ``app/Config/Validation.php``
132+
* ``app/Config/View.php``
133+
* ``app/Controllers/BaseController.php``
134+
* ``app/Controllers/Home.php``
135+
* ``app/Views/errors/cli/error_404.php``
136+
* ``app/Views/errors/cli/error_exception.php``
137+
* ``app/Views/errors/html/debug.css``
138+
* ``app/Views/errors/html/debug.js``
139+
* ``app/Views/errors/html/error_exception.php``
140+
* ``composer.json``
141+
* ``env``
142+
* ``license.txt``
143+
* ``phpunit.xml.dist``
144+
* ``public/.htaccess``
145+
* ``public/index.php``
146+
* ``spark``

‎user_guide_src/source/installation/upgrade_412.rst‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,29 @@
22
Upgrading from 4.1.1 to 4.1.2
33
#############################
44

5+
**current_url() and indexPage**
6+
7+
Due to `a bug <https://github.com/codeigniter4/CodeIgniter4/issues/4116>`_ in ``current_url()``,
8+
the resulting URIs could be incorrect for a project's configuration, most importantly: ``indexPage``
9+
would *not* be included. Projects using ``App::$indexPage`` should expect altered values from
10+
``current_url()`` and all its dependencies (including Response Testing, Pager, Form Helper, Pager,
11+
and View Parser). Update your projects accordingly.
12+
13+
**Cache Keys**
14+
15+
Cache handlers had wildly different compatibility for keys. The updated cache drivers now pass
16+
all keys through validation, roughly matching PSR-6's recommendations:
17+
18+
A string of at least one character that uniquely identifies a cached item. Implementing libraries
19+
MUST support keys consisting of the characters A-Z, a-z, 0-9, _, and . in any order in UTF-8 encoding
20+
and a length of up to 64 characters. Implementing libraries MAY support additional characters and
21+
encodings or longer lengths, but must support at least that minimum. Libraries are responsible for
22+
their own escaping of key strings as appropriate, but MUST be able to return the original unmodified
23+
key string. The following characters are reserved for future extensions and MUST NOT be supported by
24+
implementing libraries: ``{}()/\@:``
25+
26+
Update your projects to remove any invalid cache keys.
27+
528
**BaseConnection::query() return values**
629

730
``BaseConnection::query()`` method in prior versions was incorrectly returning BaseResult objects
@@ -58,3 +81,62 @@ changes to be aware of:
5881

5982
* ``TestResponse``'s ``$request`` and ``$response`` properties are protected and should only be access through their getter methods, ``request()`` and ``response()``
6083
* ``TestResponse`` does not have ``getBody()`` and ``setBody()`` methods, but rather uses the Response methods directly, e.g.: ``$body = $result->response()->getBody();``
84+
85+
Project Files
86+
=============
87+
88+
Numerous files in the project space (root, app, public, writable) received updates. Due to
89+
these files being outside of the system scope they will not be changed without your intervention.
90+
There are some third-party CodeIgniter modules available to assist with merging changes to
91+
the project space: `Explore on Packagist <https://packagist.org/explore/?query=codeigniter4%20updates>`_.
92+
93+
.. note:: Except in very rare cases for bug fixes, no changes made to files for the project space
94+
will break your application. All changes noted here are optional until the next major version,
95+
and any mandatory changes will be covered in the sections above.
96+
97+
Content Changes
98+
---------------
99+
100+
The following files received significant changes (including deprecations or visual adjustments)
101+
and it is recommended that you merge the updated versions with your application:
102+
103+
* ``app/Config/App.php``
104+
* ``app/Config/Autoload.php``
105+
* ``app/Config/Cookie.php``
106+
* ``app/Config/Events.php``
107+
* ``app/Config/Exceptions.php``
108+
* ``app/Config/Security.php``
109+
* ``app/Views/errors/html/*``
110+
* ``env``
111+
* ``spark``
112+
113+
All Changes
114+
-----------
115+
116+
This is a list of all files in the project space that received changes;
117+
many will be simple comments or formatting that have no affect on the runtime:
118+
119+
* ``app/Config/App.php``
120+
* ``app/Config/Autoload.php``
121+
* ``app/Config/ContentSecurityPolicy.php``
122+
* ``app/Config/Cookie.php``
123+
* ``app/Config/Events.php``
124+
* ``app/Config/Exceptions.php``
125+
* ``app/Config/Logger.php``
126+
* ``app/Config/Mimes.php``
127+
* ``app/Config/Modules.php``
128+
* ``app/Config/Security.php``
129+
* ``app/Controllers/BaseController.php``
130+
* ``app/Views/errors/html/debug.css``
131+
* ``app/Views/errors/html/error_404.php``
132+
* ``app/Views/errors/html/error_exception.php``
133+
* ``app/Views/welcome_message.php``
134+
* ``composer.json``
135+
* ``contributing/guidelines.rst``
136+
* ``env``
137+
* ``phpstan.neon.dist``
138+
* ``phpunit.xml.dist``
139+
* ``public/.htaccess``
140+
* ``public/index.php``
141+
* ``rector.php``
142+
* ``spark``

0 commit comments

Comments
 (0)