Skip to content

Commit

Permalink
Add release docs
Browse files Browse the repository at this point in the history
  • Loading branch information
milliams committed Aug 23, 2024
1 parent b506afb commit da3a3e0
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions RELEASE.md
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.

0 comments on commit da3a3e0

Please sign in to comment.