Skip to content

Commit f9b4f48

Browse files
authored
Merge pull request #2179 from jim-parry/rc1-prep
RC.1 prep
2 parents 4c7ed50 + e453feb commit f9b4f48

File tree

4 files changed

+128
-25
lines changed

4 files changed

+128
-25
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ We expect all contributions to conform to our [style guide](https://github.com/c
77
be documented (in the [user guide](https://codeigniter4.github.io/userguide/)), and unit tested (in the [test folder](https://github.com/codeigniter4/CodeIgniter4/tree/develop/tests)).
88
There is a [Contributing to CodeIgniter](./contributing/README.rst) section in the repository which describes the contribution process; this page is an overview.
99

10+
The [Open Source Guide](https://opensource.guide/) is a good first read for those new to contributing to open source!
1011
## Issues
1112

1213
Issues are a quick way to point out a bug. If you find a bug or documentation error in CodeIgniter then please make sure that:
@@ -39,9 +40,22 @@ CodeIgniter4 requires [PHP 7.2](https://php.net/releases/7_2_0.php).
3940

4041
### Branching
4142

42-
CodeIgniter4 uses the [Git-Flow](http://nvie.com/posts/a-successful-git-branching-model/) branching model which requires all Pull Requests to be sent to the "develop" branch; this is where the next planned version will be developed. The "master" branch will always contain the latest stable version and is kept clean so a "hotfix" (e.g. an emergency security patch) can be applied to the "master" branch to create a new version, without worrying about other features holding it up. For this reason, all commits need to be made to the "develop" branch, and any sent to the "master" branch will be closed automatically. If you have multiple changes to submit, please place all changes into their own branch on your fork.
43-
44-
**One thing at a time:** A pull request should only contain one change. That does not mean only one commit, but one change - however many commits it took. The reason for this is that if you change X and Y, but send a pull request for both at the same time, we might really want X but disagree with Y, meaning we cannot merge the request. Using the Git-Flow branching model you can create new branches for both of these features and send two requests.
43+
CodeIgniter4 uses the [Git-Flow](http://nvie.com/posts/a-successful-git-branching-model/) branching model which requires all
44+
Pull Requests to be sent to the "develop" branch; this is where the next planned version will be developed.
45+
The "master" branch will always contain the latest stable version and is kept clean so a "hotfix" (e.g. an
46+
emergency security patch) can be applied to the "master" branch to create a new version, without worrying
47+
about other features holding it up. For this reason, all commits need to be made to the "develop" branch,
48+
and any sent to the "master" branch will be closed automatically. If you have multiple changes to submit,
49+
please place all changes into their own branch on your fork.
50+
51+
**One thing at a time:** A pull request should only contain one change. That does not mean only one commit,
52+
but one change - however many commits it took. The reason for this is that if you change X and Y,
53+
but send a pull request for both at the same time, we might really want X but disagree with Y,
54+
meaning we cannot merge the request. Using the Git-Flow branching model you can create new
55+
branches for both of these features and send two requests.
56+
57+
A reminder: **please use separate branches for each of your PRs** - it will make it easier for you to keep changes separate from
58+
each other and from whatever else you are doing with your repository!
4559

4660
### Signing
4761

admin/starter/composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"license": "MIT",
77
"require": {
88
"php": ">=7.2",
9-
"codeigniter4/framework": "^4@beta"
9+
"codeigniter4/framework": "^4@rc"
1010
},
1111
"require-dev": {
1212
"mikey179/vfsstream": "1.6.*",

user_guide_src/source/changelogs/next.rst

Lines changed: 107 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,30 @@ Enhancements:
99

1010
- CI3 Email ported to CI4
1111
- Encryption (basic) added
12-
- Migrations refactored for more wholistic functionality (BC)
12+
- Migrations refactored and streamlined for more wholistic functionality (BC)
1313
- added convert() to ImageHandlerInterface
1414
- disabled debug toolbar for downloads
15+
- CLI commands returns an error code now ("spark" changed)
16+
- RESTful controllers added to shorten dev time for RESTful APIs
17+
- added RouteCollection::presenter() as part of the RESTful support
1518

1619
App changes:
1720

21+
- added app/Common to make it easier to override common functions
1822
- Config/Email and Encryption added
1923
- Config/Migration modified, and has different settings
2024
- Controllers/Home fixed, removing unnecessary model reference
2125

26+
Message changes:
27+
28+
- Migration has new & modified messages
29+
- Messages now has RESTful set
30+
2231
The list of changed files follows, with PR numbers shown.
2332

2433
- admin/
34+
- release-appstarter #2155
35+
- release-framework #2155
2536

2637
- app/
2738
- Config/
@@ -32,6 +43,8 @@ The list of changed files follows, with PR numbers shown.
3243
- BaseController #2046
3344
- Home #2145
3445

46+
- Common #2110
47+
3548
- public/
3649

3750
- system/
@@ -42,18 +55,21 @@ The list of changed files follows, with PR numbers shown.
4255
- FileLocator #2149
4356
- Cache/Handlders/
4457
- RedisHandler #2144
58+
- CLI/
59+
- CommandRunner #2164
4560
- Commands/Database/
4661
- CreateMigration #2065
47-
- MigrationCurrent #2065
48-
- MigrationLatest #2065
49-
- MigrationRefresh #2065
50-
- MigrationRollback #2065
62+
- Migrate #2065, 2137
63+
- MigrateRefresh #2065, 2137
64+
- MigrateRollback #2065, 2137
65+
- MigrateStatus #2137
66+
- MigrateVersion #2137
5167
- Config/
5268
- BaseConfig #2082
5369
- Services #2135, 2092
5470
- Database/
55-
- BaseBuilder #2127, 2090, 2142
56-
- MigrationRunner #2065
71+
- BaseBuilder #2127, 2090, 2142, 2153, 2160, 2023, 2001
72+
- MigrationRunner #2065, 2137
5773
- Debug/
5874
- Toolbar #2118
5975
- Email/
@@ -66,67 +82,134 @@ The list of changed files follows, with PR numbers shown.
6682
- BaseHandler #2135
6783
- OpenSSLHandler #2135
6884
- Exceptions/
69-
- ConfigException #2065
85+
- ConfigException #2065
86+
- Files/
87+
- File #2178
7088
- Filters/
7189
- DebugToolbar #2118
7290
- Helpers/
7391
- inflector_helper #2065
92+
- Honeypot/
93+
- Honeypot #2177
7494
- HTTP/
7595
- DownloadResponse #2129
7696
- Files/UploadedFile #2128
97+
- Message @2171
98+
- Response #2166
7799
- Images/
78-
- Handlers/BaseHandler #2113, 2150
100+
- Handlers/
101+
-BaseHandler #2113, 2150
102+
- ImageMagickHandler #2151
79103
- BImageHandlerInterface #2113
80104
- Language/en/
81105
- Email #2092
82106
- Encryption #2135
83-
- Migrations #2065
107+
- Migrations #2065, 2137
108+
- RESTful #2165
109+
- RESTful/
110+
- ResourceController #2165
111+
- ResourcePresenter #2165
112+
- Router/
113+
- RouteCollection #2165
114+
- Security/
115+
- Security #2027
84116
- Session/Handlers/
85117
- RedisHandler #2125
86-
- CodeIgniter #2126
118+
- Test/
119+
- CIDatabaseTestCase #2137
120+
121+
- bootstrap #2110
122+
- CodeIgniter #2126, 2164
87123
- Common #2109
124+
- Entity #2112
88125
- Model #2090
89126

127+
- tests/_support/
128+
- RESTful/... #2165
90129

91130
- tests/system/
92131
- API/
93132
- ResponseTraitTest #2131
94133
- Database/
95-
- Builder/GetTest #2142
96-
- Live/ModelTest #2090
97-
- Migrations/MigrationRunnerTest #2065
134+
- Builder/
135+
- GetTest #2142
136+
- SelectTest #2160
137+
- WhereTest #2001
138+
- Live/
139+
- GroupTest #2160
140+
- ModelTest #2090
141+
- SelectTest #2160
142+
- Migrations/MigrationRunnerTest #2065, 2137
98143
- Encryption/
99144
- EncryptionTest #2135
100145
- OpenSSLHandlerTest #2135
101146
- Helpers/
102147
- InflectorHelperTest #2065
103148
- HTTP/
104-
DownloadResponseTest #2129
149+
- DownloadResponseTest #2129
150+
- MessageTest #2171
105151
- Images/
106152
- GDHandlerTest #2113
153+
- RESTful/
154+
- ResourceControllerTest #2165
155+
- ResourcePresenterTest #2165
156+
- Router/
157+
- RouteCollectionTest #2165
158+
159+
- ControllerTest #2165
160+
- EntityTest #2112
107161

108162
- user_guide_src/
163+
- changelogs/
164+
- next #2154
165+
- database/
166+
- query_builder #2160, 2001
109167
- dbmgmt/
110-
- migrations #2065, 2132, 2136
168+
- migrations #2065, 2132, 2136, 2154, 2137
169+
- extending/
170+
- common #2162
111171
- helpers/
112172
- inflector_helper #2065
173+
- incoming/
174+
- restful #2165
175+
- routing #2165
113176
- libraries/
114-
- email #2092
177+
- email #2092, 2154
115178
- encryption #2135
116-
- images #2113
179+
- images #2113, 2169
117180
- outgoing/
118181
- api_responses #2131
119182
- localization #2134
120183
- response #2129
184+
- testing/
185+
- database #2137
186+
187+
- CONTRIBUTING.md #2010
188+
- README.md #2010
189+
- spark
121190

122191
PRs merged:
123192
-----------
124193

194+
- #2178 Add fallback for missing finfo_open
195+
- #2177 Fix missing form close tag
196+
- #2171 Setheader dupes
197+
- #2169 Add $quality usage for Image Library
198+
- #2166 Cookie error
199+
- #2165 RESTful help
200+
- #2164 Exit error code on CLI Command failure
201+
- #2162 User Guide updates for Common.php
202+
- #2160 Add BaseBuilder SelectCount
203+
- #2155 Include .gitignore in starters
204+
- #2153 Bug fix countAllResults with LIMIT
205+
- #2154 Fix email & migrations docs; update changelog
206+
- #2151 ImageMagick->save() return value
125207
- #2150 New logic for Image->fit()
126208
- #2149 listNamespaceFiles: Ensure trailing slash
127209
- #2145 Remove UserModel reference from Home controller
128210
- #2144 Update Redis legacy function
129211
- #2142 Fixing BuilderBase resetting when getting the SQL
212+
- #2137 New Migration Logic
130213
- #2136 Migrations user guide fixes
131214
- #2135 Encryption
132215
- #2134 Fix localization writeup
@@ -139,9 +222,15 @@ PRs merged:
139222
- #2125 Updated redis session handler to support redis 5.0.x
140223
- #2118 Disabled Toolbar on downloads
141224
- #2113 Add Image->convert()
225+
- #2112 Update `Entity.php` `__isset` method
226+
- #2110 Added app/Common.php
142227
- #2109 Fix typo in checking if exists db_connect()
143228
- #2092 Original email port
144229
- #2090 Fix prevent soft delete all without conditions set
145230
- #2082 Update BaseConfig.php
146231
- #2065 Migration updates for more wholistic functionality
147232
- #2046 clean base controller code
233+
- #2027 Fix CSRF hash regeneration
234+
- #2023 whereIn $value do not have to be an array
235+
- #2010 Fix CSRF hash regenerationerbiage revisions
236+
- #2001 Subqueries in BaseBuilder

user_guide_src/source/installation/installing_composer.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Installation & Setup
3232

3333
In the folder above your project root::
3434

35-
composer create-project codeigniter4/appstarter project-root -s beta
35+
composer create-project codeigniter4/appstarter project-root -s rc
3636

3737
The command above will create a "project-root" folder.
3838

@@ -46,7 +46,7 @@ trusted dependencies that we bundle, being composer-installed.
4646

4747
A sample such installation command, using the default project-root "appstarter"::
4848

49-
composer create-project codeigniter4/appstarter -s beta --no-dev
49+
composer create-project codeigniter4/appstarter -s rc --no-dev
5050

5151
After installation you should follow the steps in the "Upgrading" section.
5252

@@ -158,7 +158,7 @@ will be your document root.
158158

159159
In your project root::
160160

161-
composer require codeigniter4/framework @beta
161+
composer require codeigniter4/framework @rc
162162

163163
As with the earlier two composer install methods, you can omit installing
164164
phpunit and its dependencies by adding the "--no-dev" argument to the "composer require" command.

0 commit comments

Comments
 (0)