shaba/awx
1
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2024-10-27 00:55:06 +03:00
Code Releases Activity

Adds more detail to the AWX release notes

Browse Source
This commit is contained in:
Alex Corey 2022-01-21 11:12:37 -05:00
parent 8d4d1d594b
commit ddbd143793
3 changed files with 27 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/img/compare_release_branch.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 156 KiB

BIN
docs/img/pr_compare_list.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 168 KiB

30
docs/release_process.md
View File

@ -2,6 +2,22 @@
The release process for AWX is completely automated as of version 19.5.0.
## Get latest release version and list of new work
1. Get latest version of [AWX](https://github.com/ansible/awx/releases)
2. Get latest version of [AWX Operator](https://github.com/ansible/awx-operator/releases).
3. [Compare](https://github.com/ansible/awx/compare) `latest` against `devel`
![Comparing Branches](img/compare_release_branch.png)
The page will automatically update with a list of PRs that are in `AWX/devel` but not in `latest`.
![PR Compare List](img/pr_compare_list.png)
Use this list of PRs to decide if this is a Y-stream (minor) release, or a Z-stream release (patch). Use [semver](https://semver.org/#summary) to help determine what kind of release is needed. Indicators of a Z-stream release:
- No significant new features have been merged into devel since the last release.
## Staging the release
To stage the release, maintainers of this repository can run the [Stage Release](https://github.com/ansible/awx/blob/devel/.github/workflows/stage.yml) workflow. To start the workflow, follow this series of events:
@ -9,9 +25,18 @@ To stage the release, maintainers of this repository can run the [Stage Release]
1. Click "Actions" in the top nav bar on the repository
2. Click "Stage Release" in the left nav menu
3. Click the "Run workflow" dropdown
4. Populate the inputs
4. Populate the inputs.
5. Click the "Run workflow" button
If the latest release of `AWX` is 19.5.0:
- Y-stream release version will be 19.6.0.
- Z-stream release version will be 19.5.1.
With very few exceptions the new `AWX Operator` release will always be a Y-stream release.
## For AWX-Operator release version:
![Staging AWX](img/stage-release.png)
This workflow will:
@ -27,9 +52,9 @@ Once complete, navigate to the [Releases page](https://github.com/ansible/awx/re
Next, click "Publish Release":
![Publish release](img/publish-release.png)
This will not take long. Once this is complete go to [AWX-Operator release page](https://github.com/ansible/awx-operator/releases) to verify and then publish the draft release following the same steps as above.
Once the release is published, another workflow called [Promote Release](https://github.com/ansible/awx/actions/workflows/promote.yml) will start running:
@ -37,7 +62,6 @@ Once the release is published, another workflow called [Promote Release](https:/
Once it finished, verify that the new image is present on the [Repository Tags](https://quay.io/repository/ansible/awx?tag=latest&tab=tags) on Quay:
![Verify released AWX image](img/verify-released-awx-image.png)
Once the AWX image is live, go to the [Releases page for awx-operator](https://github.com/ansible/awx-operator/releases) and follow the same process to publish the release. Once published, the workflow [Promote AWX Operator image](https://github.com/ansible/awx-operator/actions/workflows/promote.yaml) will run.