Skip to content

Commit 11ade44

Browse files
authored
Merge pull request #1 from bcit-ci/develop
updated version
2 parents 8f860f2 + b263ea5 commit 11ade44

File tree

202 files changed

+4299
-1772
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

202 files changed

+4299
-1772
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
---
8+
name: Bug report
9+
about: Help us improve the framework by reporting bugs!
10+
11+
---
12+
13+
**Direction**
14+
We use github issues to track bugs, not for support.
15+
If you have a support question, or a feature request, raise these as threads on our
16+
[forum](https://forum.codeigniter.com/index.php).
17+
18+
**Describe the bug**
19+
A clear and concise description of what the bug is.
20+
21+
**CodeIgniter 4 version**
22+
Which version (and branch, if applicable) the bug is in.
23+
24+
**Affected module(s)**
25+
Which package or class is the bug in, if known.
26+
27+
**Expected behavior, and steps to reproduce if appropriate**
28+
A clear and concise description of what you expected to happen,
29+
and how you got there.
30+
Feel free to include a text/log extract, but use a pastebin facility for any
31+
screenshots you deem necessary.
32+
33+
**Context**
34+
- OS: [e.g. Windows 99]
35+
- Web server [e.g. Apache 1.2.3]
36+
- PHP version [e.g. 6.5.4]

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,10 @@ writable/logs/*
5757
!writable/logs/index.html
5858
!writable/logs/.htaccess
5959

60+
writable/session/*
61+
!writable/session/index.html
62+
!writable/session/.htaccess
63+
6064
writable/uploads/*
6165
!writable/uploads/index.html
6266
!writable/uploads/.htaccess
@@ -127,3 +131,4 @@ nb-configuration.xml
127131

128132
/results/
129133
/phpunit*.xml
134+

.nojekyll

Whitespace-only changes.

.travis.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ dist: precise
2121
env:
2222
- DB=mysqli
2323
- DB=postgres
24+
- DB=sqlite
2425

2526
services:
2627
- memcached

CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

PULL_REQUEST_TEMPLATE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Each pull request should address a single issue, and have a meaningful title.
2+
3+
**Description**
4+
Explain what you have changed, and why.
5+
6+
**Checklist:**
7+
- [ ] Securely signed commits
8+
- [ ] Component(s) with PHPdocs
9+
- [ ] Unit testing, with >80% coverage
10+
- [ ] User guide updated
11+
- [ ] Conforms to style guide
12+
13+
---------Remove from here down in your description----------
14+
15+
**Notes**
16+
- Pull requests must be in English
17+
- If the PR solves an issue, reference it with a suitable verb and the issue number
18+
(e.g. fixes <hash>12345
19+
- Unsolicited PRs will be considered, but there is no guarantee of acceptance
20+
- Pull requests should be from a feature branch in the contributor's fork of the repository
21+
to the develop branch of the project repository
22+

admin/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# CodeIgniter 4 Admin
2+
3+
This folder contains tools or docs useful for project maintainers.
4+
5+
- [docbot](./docbot.md) - build & deploy user guide
6+
- [release](./release.md) - build & deploy framework release

admin/docbot

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
#!/bin/bash
2+
3+
# Rebuild and deploy CodeIgniter4 user guide
4+
5+
UPSTREAM=https://github.com/bcit-ci/CodeIgniter4.git
6+
7+
# Prepare the nested repo clone folder
8+
cd user_guide_src
9+
rm -rf build/*
10+
mkdir build/html
11+
12+
# Get ready for git
13+
cd build/html
14+
git init
15+
git remote add origin $UPSTREAM
16+
git fetch
17+
git checkout gh-pages
18+
git reset --hard origin/gh-pages
19+
rm -r *
20+
21+
# Make the new user guide
22+
cd ../..
23+
make html
24+
25+
# All done?
26+
if [ $# -lt 1 ]; then
27+
exit 0
28+
fi
29+
30+
# Optionally update the remote repo
31+
if [ $1 = "deploy" ]; then
32+
cd build/html
33+
git add .
34+
git commit -S -m "Docbot synching"
35+
git push -f origin gh-pages
36+
fi

admin/docbot.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# docbot
2+
3+
Builds & deploys user guide.
4+
5+
The CI4 user guide, warts & all, is rebuilt in a nested
6+
repository clone (`user_guide_src/build/html`), with the result
7+
optionally pushed to the `gh-pages` branch of the repo.
8+
That would then be publically visible as the in-progress
9+
version of the [User Guide](https://bcit-ci.github.io/CodeIgniter4/).
10+
11+
## Audience
12+
13+
This script is intended for use by framework maintainers,
14+
i.e. someone with commit rights on the CI4 repository.
15+
16+
This script wraps the conventional user guide building,
17+
i.e. `user_guide_src/make html`, with additional
18+
steps.
19+
20+
You will be prompted for your github credentials and
21+
GPG-signing key as appropriate.
22+
23+
## Usage
24+
25+
Inside a shell prompt, in the project root:
26+
27+
`admin/docbot [deploy]`
28+
29+
If "deploy" is not added, the script execution is considered
30+
a trial run, and nothing is pushed to the repo.
31+
32+
Whether or not deployed, the results are left inside
33+
user_guide_src/build (which is git ignored).

admin/post_release

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
#~/bin/bash
2+
3+
## Cleanup after a framework release
4+
5+
UPSTREAM=https://github.com/bcit-ci/CodeIgniter4.git
6+
version=4
7+
qualifier=
8+
9+
branch=post-release-
10+
devonly='.github/* admin/* build/* contributing/* user_guide_src/* CODE_OF_CONDUCT.md \
11+
DCO.txt PULL_REQUEST_TEMPLATE.md'
12+
which=release
13+
14+
BOLD='\033[1m'
15+
NORMAL='\033[0m'
16+
COLOR='\033[1;31m'
17+
ERROR='\033[0;31m'
18+
19+
echo -e "${BOLD}${COLOR}CodeIgniter4 release cleanup${NORMAL}"
20+
echo '----------------------------'
21+
22+
#---------------------------------------------------
23+
# Check arguments
24+
echo -e "${BOLD}Checking arguments...${NORMAL}"
25+
26+
if [ $# -lt 1 ]; then
27+
echo "You really need to read the directions first!"
28+
exit 1
29+
fi
30+
31+
version=$1
32+
if [ $# -gt 1 ]; then
33+
qualifier="-${2}"
34+
which='pre-release'
35+
fi
36+
release_branch="release-$version$qualifier"
37+
branch="post-${release_branch}"
38+
39+
#---------------------------------------------------
40+
# Create the post-release branch
41+
echo -e "${BOLD}Creating $branch${NORMAL}"
42+
43+
git checkout $release_branch
44+
git branch -d $branch # remove the branch if there
45+
git checkout -b $branch
46+
47+
#---------------------------------------------------
48+
# Put our house back in order
49+
echo -e "${BOLD}Put our house back in order${NORMAL}"
50+
51+
mv -r admin/previous-gitignore .gitignore
52+
rm -Rf docs
53+
54+
#---------------------------------------------------
55+
# Add next version block in changelog.rst
56+
echo -e "${BOLD}Setup next release${NORMAL}"
57+
sed -i '5 i\
58+
Version |release|
59+
====================================================
60+
61+
Release Date: Not Released
62+
' user_guide_src/source/changelog.rst
63+
64+
git add .
65+
git commit -S -m "Post ${branch} cleanup"
66+
67+
#---------------------------------------------------
68+
# Cleanup master
69+
echo -e "${BOLD}Cleanup the master branch${NORMAL}"
70+
git checkout master
71+
git merge ${branch}
72+
git push origin master
73+
#git push UPSTREAM master
74+
75+
#---------------------------------------------------
76+
# Cleanup develop
77+
echo -e "${BOLD}Cleanup the develop branch${NORMAL}"
78+
git checkout develop
79+
git merge ${branch}
80+
git push origin develop
81+
#git push UPSTREAM develop
82+
83+
# keep or delete the release branch? up to you
84+
# at this point, you should have uptodate develop and master,
85+
# as well as the release and post-release branches
86+
87+
#---------------------------------------------------
88+
# Phew!
89+
90+
echo -e "${BOLD}Congratulations - we have liftoff${NORMAL}"
91+
echo "Don't forget to announce this release on the forum and on twitter!"

0 commit comments

Comments
 (0)