Skip to content

Commit 7bbe9d2

Browse files
authored
update release instructions: update webpage before tagging (#119)
1 parent 9f03a96 commit 7bbe9d2

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

docs/release_instructions.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
## Release Instructions
22

3-
The AppWrapper project release process is driven via GitHub actions.
43

5-
To make a release, create a new release tag (vX.Y.Z) and push the
4+
1. Submit a housekeeping PR that does the following:
5+
+ Update the AppWrapper version number in the installation section of [README.md](../README.md#Installation).
6+
+ Update the `appwrapper_version` and `kueue_version` variables in [_config.yaml](../site/_config.yaml).
7+
8+
2. After merging the PR, create a new release tag (vX.Y.Z) and push the
69
tag to the main branch. This will trigger the `release` workflow which
710
will:
811
+ build, tag, and push images to [quay.io/ibm/appwrapper](https://quay.io/repository/ibm/appwrapper)
912
+ generate the install.yaml for the release
1013
+ create a [GitHub release](https://github.com/project-codeflare/appwrapper/releases) that contains the install.yaml
11-
12-
After the automated release process completes, do a followup PR containing the
13-
following updates to the main README and project website:
14-
+ Update the AppWrapper version number in the installation section of [README.md](../README.md#Installation).
15-
+ Update the `appwrapper_version` and `kueue_version` variables in [_config.yaml](../site/_config.yaml).

0 commit comments

Comments
 (0)