Skip to content

Commit 3dd1631

Browse files
jim-parryjim-parry
committed
Merge branch 'develop' of https://github.com/bcit-ci/CodeIgniter4 into develop
2 parents 5a1cde9 + 5f1e482 commit 3dd1631

30 files changed

+1068
-510
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
CodeIgniter is a PHP full-stack web framework that is light, fast, flexible, and secure.
99
More information can be found at the [official site](http://codeigniter.com).
1010

11-
This repository holds the pre-alpha code for CodeIgniter 4 only.
11+
This repository holds the alpha code for CodeIgniter 4 only.
1212
Version 4 is a complete rewrite to bring the quality and the code into a more modern version,
1313
while still keeping as many of the things intact that has made people love the framework over the years.
1414

‎admin/README.md

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This folder contains tools or docs useful for project maintainers.
44

5-
##Repositories Organization, inside https://github.com/codeigniter4
5+
##Repositories inside https://github.com/codeigniter4
66

77
- **CodeIgniter4** is the main development repository.
88
It supports issues and pull requests, and has a rule to enforce GPG-signed commits.
@@ -23,7 +23,7 @@ This folder contains tools or docs useful for project maintainers.
2323
- **userguide** is released documentation publishing repository.
2424
It contains built versions of the user guide, corresponding to the
2525
framework releases.
26-
It could be downloaded, forked or composer-installed.
26+
It could be downloaded, forked or potentially composer-installed.
2727
This is a read-only repository.
2828

2929
- **coding-standard** is the coding style standards repository.
@@ -45,6 +45,7 @@ This folder contains tools or docs useful for project maintainers.
4545

4646
##Maintainer Scripts
4747

48+
- **release-config** holds variables used for the maintainer & release building
4849
- **docbot** re-builds the user guide from the RST source for it,
4950
and optionally deploys it to the `gh-pages` branch of the main
5051
repository (if the user running it has maintainer rights on that repo).
@@ -55,22 +56,35 @@ This folder contains tools or docs useful for project maintainers.
5556
The release workflow is detailed in its own writeup; these are the main
5657
scripts used by the release manager:
5758

58-
- **pre-release** builds a new release branch in the main repo, for vetting.
59+
- **release** builds a new release branch in the main repo, for vetting.
5960
This includes updating version dependencies or constants,
6061
generating version(s) of the user guide; and possibly
6162
moving or ignoring stuff, distinguishing release from development.
62-
If successful, it will leave a `releasing` file, with the version number
63-
in it.
64-
- **release** builds release branches for the derived repositories
65-
(framework, appstarter and userguide).
66-
These are pushed to the respective repositories (if the user has maintainer
67-
rights), but the actual associated releases are created on github.com manually, so
68-
that additional binaries can be added to the release if appropriate.
69-
- **post-release** cleans up after a release, eg. setting up the changelog for
70-
the next release.
63+
If successful, it will update the `config` file, with the version number
64+
in it, and it will run the related scripts following, to revise
65+
the release distributions.
66+
Usage: `admin/release version qualifier`
67+
- **release-framework** builds the distributable framework repo.
68+
It could be used on its own, but is normally part of `release`.
69+
- **release-appstarter** builds the distributable appstarter repo.
70+
It could be used on its own, but is normally part of `release`.
71+
- **release-userguide** builds the distributable userguide repo.
72+
It could be used on its own, but is normally part of `release`.
73+
- **release-deploy** pushes the release changes to the appropriate github
74+
repositories. Tag & create releases on github. This is not easily reversible!
75+
Usage: `admin/release-deploy version qualifier`
76+
- **release-revert** can be used to restore your repositories to the state they
77+
were in before you started a release. **IF** you haven't deployed.
78+
This is in case you decide not to proceed with the release, for any reason.
79+
Remember to be polite when running it.
7180

7281

7382
##Other Stuff
7483

7584
- **release-notes.bb** is a boilerplate for forum announcements of a new release.
76-
It is marked up using [BBcode](https://en.wikipedia.org/wiki/BBCode).
85+
It is marked up using [BBcode](https://en.wikipedia.org/wiki/BBCode).
86+
- The **framework** and **starter** subfolders contain files that will over-ride
87+
those from the development repository, when the distribution repositories
88+
are built.
89+
- The subfolders inside `admin` contain "next release" files in the case of
90+
`codeigniter4` and over-written distribution files in the other cases.

‎admin/docbot

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Rebuild and deploy CodeIgniter4 user guide
44

5-
UPSTREAM=https://github.com/codeigniter4/CodeIgniter4.git
5+
. config
66

77
# Prepare the nested repo clone folder
88
cd user_guide_src

‎admin/framework/README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# CodeIgniter 4 Framework
2+
3+
## What is CodeIgniter?
4+
CodeIgniter is a PHP full-stack web framework that is light, fast, flexible, and secure.
5+
More information can be found at the [official site](http://codeigniter.com).
6+
7+
This repository holds the distributable version of the framework,
8+
including the user guide. It has been built from the
9+
[development repository](https://github.com/codeigniter4/CodeIgniter4).
10+
11+
**This is pre-release code and should not be used in production sites.**
12+
13+
More information about the plans for version 4 can be found in [the announcement](http://forum.codeigniter.com/thread-62615.html) on the forums.
14+
15+
The user guide corresponding to this version of the framework can be found
16+
[here](https://codeigniter4.github.io/userguide/).
17+
18+
19+
## Important Change with index.php
20+
21+
`index.php` is no longer in the root of the project! It has been moved inside the *public* folder,
22+
for better security and separation of components.
23+
24+
This means that you should configure your web server to "point" to your project's *public* folder, and
25+
not to the project root. A better practice would be to configure a virtual host to point there. A poor practice would be to point your web server to the project root and expect to enter *public/...*, as the rest of your logic and the
26+
framework are exposed.
27+
28+
**Please** read the user guide for a better explanation of how CI4 works!
29+
The user guide updating and deployment is a bit awkward at the moment, but we are working on it!
30+
31+
## Repository Management
32+
We use Github issues to track **BUGS** and to track approved **DEVELOPMENT** work packages.
33+
We use our [forum](http://forum.codeigniter.com) to provide SUPPORT and to discuss
34+
FEATURE REQUESTS.
35+
36+
If you raise an issue here that pertains to support or a feature request, it will
37+
be closed! If you are not sure if you have found a bug, raise a thread on the forum first -
38+
someone else may have encountered the same thing.
39+
40+
Before raising a new Github issue, please check that your bug hasn't already
41+
been reported or fixed.
42+
43+
We use pull requests (PRs) for CONTRIBUTIONS to the repository.
44+
We are looking for contributions that address one of the reported bugs or
45+
approved work packages.
46+
47+
Do not use a PR as a form of feature request.
48+
Unsolicited contributions will only be considered if they fit nicely
49+
into the framework roadmap.
50+
Remember that some components that were part of CodeIgniter 3 are being moved
51+
to optional packages, with their own repository.
52+
53+
## Contributing
54+
We welcome contributions from the community.
55+
56+
Please read the [*Contributing to CodeIgniter*](https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing.md) section in the development repository.
57+
58+
## Server Requirements
59+
PHP version 7.1 or higher is required, with the following extensions installed:
60+
61+
- [intl](http://php.net/manual/en/intl.requirements.php)
62+
- [libcurl](http://php.net/manual/en/curl.requirements.php) if you plan to use the HTTP\CURLRequest library
63+
64+
Additionally, make sure that the following extensions are enabled in your PHP:
65+
66+
- json (enabled by default - don't turn it off)
67+
- [mbstring](http://php.net/manual/en/mbstring.installation.php)
68+
- [mysqlnd](http://php.net/manual/en/mysqlnd.install.php)
69+
- xml (enabled by default - don't turn it off)

‎admin/framework/composer.json

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"name": "codeigniter4/framework",
3+
"type": "project",
4+
"description": "The CodeIgniter framework v4",
5+
"homepage": "https://codeigniter.com",
6+
"license": "MIT",
7+
"require": {
8+
"php": ">=7.1",
9+
"ext-curl": "*",
10+
"ext-intl": "*",
11+
"kint-php/kint": "^2.1",
12+
"zendframework/zend-escaper": "^2.5"
13+
},
14+
"require-dev": {
15+
"codeigniter4/codeigniter4-standard": "^1.0",
16+
"mikey179/vfsStream": "1.6.*",
17+
"phpunit/phpunit": "^7.0",
18+
"squizlabs/php_codesniffer": "^3.3"
19+
},
20+
"autoload": {
21+
"psr-4": {
22+
"CodeIgniter\\": "system/",
23+
"Psr\\Log\\": "system/ThirdParty/PSR/Log/"
24+
}
25+
},
26+
"scripts": {
27+
"post-update-cmd": [
28+
"composer dump-autoload",
29+
"CodeIgniter\\ComposerScripts::postUpdate",
30+
"bash admin/setup.sh"
31+
]
32+
},
33+
"support": {
34+
"forum": "http://forum.codeigniter.com/",
35+
"source": "https://github.com/codeigniter4/CodeIgniter4",
36+
"slack": "https://codeigniterchat.slack.com"
37+
}
38+
}

‎admin/framework/phpunit.xml.dist

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<phpunit bootstrap="tests/_support/_bootstrap.php"
3+
backupGlobals="false"
4+
colors="true"
5+
convertErrorsToExceptions="true"
6+
convertNoticesToExceptions="true"
7+
convertWarningsToExceptions="true"
8+
stopOnError="false"
9+
stopOnFailure="false"
10+
stopOnIncomplete="false"
11+
stopOnSkipped="false">
12+
<testsuites>
13+
<testsuite name="app">
14+
<directory>./tests</directory>
15+
<exclude>./tests/system</exclude>
16+
</testsuite>
17+
</testsuites>
18+
19+
<filter>
20+
<whitelist processUncoveredFilesFromWhitelist="true">
21+
<directory suffix=".php">./system</directory>
22+
<exclude>
23+
<directory>./system</directory>
24+
</exclude>
25+
</whitelist>
26+
</filter>
27+
28+
</phpunit>

‎admin/post_release

Lines changed: 0 additions & 92 deletions
This file was deleted.

0 commit comments

Comments
 (0)