-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<!-- | ||
SPDX-FileCopyrightText: © 2024 Matt Williams <matt.williams@bristol.ac.uk> | ||
SPDX-License-Identifier: CC-BY-SA-4.0 | ||
--> | ||
|
||
# Making a release | ||
|
||
Releases are completely automated by GitHub Actions: | ||
1. Make sure the [changelog](./CHANGELOG.md) is up to date. | ||
A release cannot be made if there is nothing in the changelog in the `Unreleased` section. | ||
2. Go the the [Release](https://github.com/isambard-sc/conch/actions/workflows/release.yml) workflow page. | ||
3. Click "Run workflow" in the top right. | ||
4. Make sure the `master` branch is selected. | ||
5. In the box below, type `patch`, `minor` or `major`, depending on the [SemVer level](https://semver.org) of release to make. | ||
6. Press the "Run workflow" button. | ||
|
||
This will kick off a series of chained workflows, culminating in a new release appearing on the [Releases page](https://github.com/isambard-sc/conch/releases) and images and Helm charts added to the registry. |