malhuda/CodeIgniter4
1
0
Fork 0
mirror of https://github.com/codeigniter4/CodeIgniter4.git synced 2025-02-20 11:44:28 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update release docs

Browse Source
This commit is contained in:
MGatner 2020-03-06 22:10:53 -05:00
parent 2d4017a6d6
commit 489e624369
No known key found for this signature in database
GPG Key ID: BC7C436F28470CC8
2 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
admin/README.md
View File

@ -16,7 +16,7 @@ This folder contains tools or docs useful for project maintainers.
It is meant to be downloaded by developers, or composer-installed. It is meant to be downloaded by developers, or composer-installed.
This is a read-only repository. This is a read-only repository.
- **appstarter** is the released application starter repository. - **appstarter** is the released application starter repository.
It is derived from the framework's `application` and `public` folders, with It is derived from the framework's `app` and `public` folders, with
a composer requirement dependency to pull in the framework itself. a composer requirement dependency to pull in the framework itself.
It is meant to be downloaded or composer-installed. It is meant to be downloaded or composer-installed.
This is a read-only repository. This is a read-only repository.
@ -64,14 +64,10 @@ scripts used by the release manager:
in it, and it will run the related scripts following, to revise in it, and it will run the related scripts following, to revise
the release distributions. the release distributions.
Usage: `admin/release version qualifier` Usage: `admin/release version qualifier`
- **release-framework** builds the distributable framework repo.
It could be used on its own, but is normally part of `release`.
- **release-appstarter** builds the distributable appstarter repo.
It could be used on its own, but is normally part of `release`.
- **release-userguide** builds the distributable userguide repo. - **release-userguide** builds the distributable userguide repo.
It could be used on its own, but is normally part of `release`. It could be used on its own, but is normally part of `release`.
- **release-deploy** pushes the release changes to the appropriate github - **release-deploy** pushes the release changes to the appropriate github
repositories. Tag & create releases on github. This is not easily reversible! repositories. Tag & create releases on GitHub. This is not easily reversible!
Usage: `admin/release-deploy version qualifier` Usage: `admin/release-deploy version qualifier`
- **release-revert** can be used to restore your repositories to the state they - **release-revert** can be used to restore your repositories to the state they
were in before you started a release. **IF** you haven't deployed. were in before you started a release. **IF** you haven't deployed.

16
admin/workflow.md
View File

@ -12,12 +12,12 @@ release prep (`admin/release <version> <qualifier>`)...
- move or ignore stuff, distinguishing release from development - move or ignore stuff, distinguishing release from development
- test that all is as it should be - test that all is as it should be
- merge the release branch into "master" & "develop" - merge the release branch into "master" & "develop"
- prepare the distribution repos
After these have been vetted ... After these have been vetted ...
- push the release(s) to github (`admin/release-deploy <version> <qualifier>`) - push the release(s) to github (`admin/release-deploy <version> <qualifier>`)
- **manually** create the releases & tag them on github, based on master - **manually** create the release & tag it on GitHub, based on master
Include any supplementary binaries as part of releases. Include any supplementary binaries as part of releases.
- Confirm the GitHub release action successfully deploys `appstarter` and `framework`
- **manually** post a sticky announcement thread on the forum - **manually** post a sticky announcement thread on the forum
- **manually** tweet the release announcement - **manually** tweet the release announcement
@ -37,6 +37,18 @@ This script is not intended to deal with hotfixes, i.e. PRs against
`master` that need to also be merged into `develop`, probably `master` that need to also be merged into `develop`, probably
as part of a bug fix minor release. as part of a bug fix minor release.
## GitHub Action
There is an action defined to run on any release publish event:
**.github/workflows/deploy.yml**. This will cascade any release made from
the main repo to the distribution repos, `appstarter` and `framework`. In order
for the action to authenticate you must create a Personal Access Token and add it
as a repo secret `ACCESS_TOKEN`. It is recommended that the PAT be to a secure bot
account with organization access that is dedicated for this purpose.
If for some reason a release needs to be made that should not cascade the easiest
solution is to disable repo actions temporarily.
## Usage ## Usage
Inside a shell prompt, in the project root: Inside a shell prompt, in the project root: