@@ -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,7 +45,7 @@ This folder contains tools or docs useful for project maintainers.
4545
4646##Maintainer Scripts
4747
48- - ** config** holds variables used for the maintainer & release building
48+ - ** release- config** holds variables used for the maintainer & release building
4949- ** docbot** re-builds the user guide from the RST source for it,
5050 and optionally deploys it to the ` gh-pages ` branch of the main
5151 repository (if the user running it has maintainer rights on that repo).
@@ -56,22 +56,33 @@ This folder contains tools or docs useful for project maintainers.
5656The release workflow is detailed in its own writeup; these are the main
5757scripts used by the release manager:
5858
59- - ** 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.
6060 This includes updating version dependencies or constants,
6161 generating version(s) of the user guide; and possibly
6262 moving or ignoring stuff, distinguishing release from development.
6363 If successful, it will update the ` config ` file, with the version number
64- in it.
65- - ** release** builds release branches for the derived repositories
66- (framework, appstarter and userguide).
67- These are pushed to the respective repositories (if the user has maintainer
68- rights), but the actual associated releases are created on github.com manually, so
69- that additional binaries can be added to the release if appropriate.
70- - ** post-release** cleans up after a release, eg. setting up the changelog for
71- the next release.
64+ in it, and it will run the related scripts following, to revise
65+ the release distributions.
66+ - ** release-framework** builds the distributable framework repo.
67+ It could be used on its own, but is normally part of ` release ` .
68+ - ** release-appstarter** builds the distributable appstarter repo.
69+ It could be used on its own, but is normally part of ` release ` .
70+ - ** release-userguide** builds the distributable userguide repo.
71+ It could be used on its own, but is normally part of ` release ` .
72+ - ** release-deploy** pushes the release changes to the appropriate github
73+ repositories. Tag & create releases on github. This is not easily reversible!
74+ - ** release-revert** can be used to restore your repositories to the state they
75+ were in before you started a release. ** IF** you haven't deployed.
76+ This is in case you decide not to proceed with the release, for any reason.
77+ Remember to be polite when running it.
7278
7379
7480##Other Stuff
7581
7682- ** release-notes.bb** is a boilerplate for forum announcements of a new release.
77- It is marked up using [ BBcode] ( https://en.wikipedia.org/wiki/BBCode ) .
83+ It is marked up using [ BBcode] ( https://en.wikipedia.org/wiki/BBCode ) .
84+ - The ** framework** and ** starter** subfolders contain files that will over-ride
85+ those from the development repository, when the distribution repositories
86+ are built.
87+ - The subfolders inside ` admin ` contain "next release" files in the case of
88+ ` codeigniter4 ` and over-written distribution files in the other cases.
0 commit comments