|
1 | | -# CodeIgniter 4 Admin |
| 1 | +#CodeIgniter 4 Admin |
2 | 2 |
|
3 | 3 | This folder contains tools or docs useful for project maintainers. |
4 | 4 |
|
5 | | -- [docbot](./docbot.md) - build & deploy user guide |
6 | | -- [release](./release.md) - build & deploy framework release |
| 5 | +##Repositories inside https://github.com/codeigniter4 |
| 6 | + |
| 7 | +- **CodeIgniter4** is the main development repository. |
| 8 | + It supports issues and pull requests, and has a rule to enforce GPG-signed commits. |
| 9 | + In addition to the framework source, it includes unit testing and documentation source. |
| 10 | + The three repositories following are built from this one as part of the release workflow. |
| 11 | + This repo is meant to be forked by contributors. |
| 12 | + |
| 13 | +- **framework** is the released developer repository. |
| 14 | + It contains all the main pieces of the framework that developers would use to |
| 15 | + build their apps, but not the framework unit testing or the user guide source. |
| 16 | + It is meant to be downloaded by developers, or composer-installed. |
| 17 | + This is a read-only repository. |
| 18 | +- **appstarter** is the released application starter repository. |
| 19 | + It is derived from the framework's `application` and `public` folders, with |
| 20 | + a composer requirement dependency to pull in the framework itself. |
| 21 | + It is meant to be downloaded or composer-installed. |
| 22 | + This is a read-only repository. |
| 23 | +- **userguide** is released documentation publishing repository. |
| 24 | + It contains built versions of the user guide, corresponding to the |
| 25 | + framework releases. |
| 26 | + It could be downloaded, forked or potentially composer-installed. |
| 27 | + This is a read-only repository. |
| 28 | + |
| 29 | +- **coding-standard** is the coding style standards repository. |
| 30 | + It contains PHP CodeSniffer rules to ensure consistent code style |
| 31 | + within the framework itself. |
| 32 | + It is meant to be composer-installed. |
| 33 | +- **translations** is the repository holding official translations of |
| 34 | + the locale-dependent system messages. |
| 35 | + It is community-maintained, and accepts issues and pull requests. |
| 36 | + It could be downloaded, forked or composer-installed. |
| 37 | + |
| 38 | +##Contributor Scripts |
| 39 | + |
| 40 | +- **setup.sh** installs a git pre-commit hook into a contributor's |
| 41 | + local clone of their fork of the `CodeIgniter4` repository. |
| 42 | +- **pre-commit** runs PHP Lint and PHP CodeSniffer on any files |
| 43 | + to be added as part of a git commit, ensuring that they conform to the |
| 44 | + framework coding style standards, and automatically fixing what can be. |
| 45 | + |
| 46 | +##Maintainer Scripts |
| 47 | + |
| 48 | +- **release-config** holds variables used for the maintainer & release building |
| 49 | +- **docbot** re-builds the user guide from the RST source for it, |
| 50 | + and optionally deploys it to the `gh-pages` branch of the main |
| 51 | + repository (if the user running it has maintainer rights on that repo). |
| 52 | + See the [writeup](./docbot.md). |
| 53 | + |
| 54 | +##Release Building Scripts |
| 55 | + |
| 56 | +The release workflow is detailed in its own writeup; these are the main |
| 57 | +scripts used by the release manager: |
| 58 | + |
| 59 | +- **release** builds a new release branch in the main repo, for vetting. |
| 60 | + This includes updating version dependencies or constants, |
| 61 | + generating version(s) of the user guide; and possibly |
| 62 | + moving or ignoring stuff, distinguishing release from development. |
| 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. |
| 80 | + |
| 81 | + |
| 82 | +##Other Stuff |
| 83 | + |
| 84 | +- **release-notes.bb** is a boilerplate for forum announcements of a new release. |
| 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. |
0 commit comments