Skip to content

Commit 489e624

Browse files
committed
Update release docs
1 parent 2d4017a commit 489e624

2 files changed

Lines changed: 16 additions & 8 deletions

File tree

admin/README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This folder contains tools or docs useful for project maintainers.
1616
It is meant to be downloaded by developers, or composer-installed.
1717
This is a read-only repository.
1818
- **appstarter** is the released application starter repository.
19-
It is derived from the framework's `application` and `public` folders, with
19+
It is derived from the framework's `app` and `public` folders, with
2020
a composer requirement dependency to pull in the framework itself.
2121
It is meant to be downloaded or composer-installed.
2222
This is a read-only repository.
@@ -64,14 +64,10 @@ scripts used by the release manager:
6464
in it, and it will run the related scripts following, to revise
6565
the release distributions.
6666
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`.
7167
- **release-userguide** builds the distributable userguide repo.
7268
It could be used on its own, but is normally part of `release`.
7369
- **release-deploy** pushes the release changes to the appropriate github
74-
repositories. Tag & create releases on github. This is not easily reversible!
70+
repositories. Tag & create releases on GitHub. This is not easily reversible!
7571
Usage: `admin/release-deploy version qualifier`
7672
- **release-revert** can be used to restore your repositories to the state they
7773
were in before you started a release. **IF** you haven't deployed.

admin/workflow.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ release prep (`admin/release <version> <qualifier>`)...
1212
- move or ignore stuff, distinguishing release from development
1313
- test that all is as it should be
1414
- merge the release branch into "master" & "develop"
15-
- prepare the distribution repos
1615

1716
After these have been vetted ...
1817
- push the release(s) to github (`admin/release-deploy <version> <qualifier>`)
19-
- **manually** create the releases & tag them on github, based on master
18+
- **manually** create the release & tag it on GitHub, based on master
2019
Include any supplementary binaries as part of releases.
20+
- Confirm the GitHub release action successfully deploys `appstarter` and `framework`
2121
- **manually** post a sticky announcement thread on the forum
2222
- **manually** tweet the release announcement
2323

@@ -37,6 +37,18 @@ This script is not intended to deal with hotfixes, i.e. PRs against
3737
`master` that need to also be merged into `develop`, probably
3838
as part of a bug fix minor release.
3939

40+
## GitHub Action
41+
42+
There is an action defined to run on any release publish event:
43+
**.github/workflows/deploy.yml**. This will cascade any release made from
44+
the main repo to the distribution repos, `appstarter` and `framework`. In order
45+
for the action to authenticate you must create a Personal Access Token and add it
46+
as a repo secret `ACCESS_TOKEN`. It is recommended that the PAT be to a secure bot
47+
account with organization access that is dedicated for this purpose.
48+
49+
If for some reason a release needs to be made that should not cascade the easiest
50+
solution is to disable repo actions temporarily.
51+
4052
## Usage
4153

4254
Inside a shell prompt, in the project root:

0 commit comments

Comments
 (0)