Skip to content

update release instructions: update webpage before tagging #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 29, 2024
Merged

update release instructions: update webpage before tagging #119

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions docs/release_instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
## Release Instructions

The AppWrapper project release process is driven via GitHub actions.

To make a release, create a new release tag (vX.Y.Z) and push the
1. Submit a housekeeping PR that does the following:
+ Update the AppWrapper version number in the installation section of [README.md](../README.md#Installation).
+ Update the `appwrapper_version` and `kueue_version` variables in [_config.yaml](../site/_config.yaml).

2. After merging the PR, create a new release tag (vX.Y.Z) and push the
tag to the main branch. This will trigger the `release` workflow which
will:
+ build, tag, and push images to [quay.io/ibm/appwrapper](https://quay.io/repository/ibm/appwrapper)
+ generate the install.yaml for the release
+ create a [GitHub release](https://github.com/project-codeflare/appwrapper/releases) that contains the install.yaml

After the automated release process completes, do a followup PR containing the
following updates to the main README and project website:
+ Update the AppWrapper version number in the installation section of [README.md](../README.md#Installation).
+ Update the `appwrapper_version` and `kueue_version` variables in [_config.yaml](../site/_config.yaml).