Skip to content

Commit

Permalink
Updated release instructions (#658)
Browse files Browse the repository at this point in the history
Added more explicit steps to follow

Co-authored-by: Gordon Byers <gordonbyers@gmail.com>
pjlewisuk and Gordonby authored Oct 25, 2023
1 parent ee32936 commit 7178c0d
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/ReleasingHelper.md
Original file line number Diff line number Diff line change
@@ -5,6 +5,16 @@
Usually a release of the Helper Web App will be accompanied by changes to the bicep code. In which case a new symantec release tag needs to be chosen (0.8.2 or 0.8.5 etc).
There is a [GitHub action workflow](https://github.com/Azure/AKS-Construction/actions/workflows/release.yml) which is initiated manually but automates the release, all that needs to be provided is the new release tag.

- If you are not a member of the [AKS Construction Admins](https://github.com/orgs/Azure/teams/aks-construction-admins) or [AKS Construction Maintainers](https://github.com/orgs/Azure/teams/aks-construction-maintainers) groups, please ask a member of either group to be available to review your deployment - **you won't be able to complete the release without their review**
- Trigger the [Release bicep and helper](https://github.com/Azure/AKS-Construction/actions/workflows/release.yml) action, incrementing the release version by 1 (e.g. 0.10.1 :arrow_right: 0.10.2)
- Wait for the workflow to run to completion
- If any errors occur, examine the output of the job that failed and troubleshoot the issue(s). You may need to submit a fix via PR, which will require an additional person to review and approve
- If there are no errors, the action will pause on the "Deploy Web App to Prod Pages" job - you will need a repo admin or maintainer to review and approve this job to create the final release
- Navigate to the [Releases](https://github.com/Azure/AKS-Construction/releases) page and check your new release has appeared
- It should be showing with the "Pre-release" label
- Edit the release, scroll to the bottom of the page and select "Set as the latest release" and save the change
- Open that [AKS Construction helper](https://azure.github.io/AKS-Construction/) and verify that your release is now the current release

## Releasing just the Helper Web App

Occasionally there will be UI improvements that we want to release that do not have any dependencies in a new release.

0 comments on commit 7178c0d

Please sign in to comment.