Skip to content

Commit

Permalink
add release process
Browse files Browse the repository at this point in the history
Signed-off-by: Matthew Fisher <[email protected]>
  • Loading branch information
bacongobbler committed Sep 6, 2024
1 parent 63efe9c commit 42ee070
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# spin-operator release process

The vast majority of the release process is handled after you push a new git tag.

First, let's start by setting some environment variables we can reference later.

```console
export TAG=v0.x.0 #CHANGEME
```

To push a tag, do the following:

```console
git checkout main
git remote add upstream [email protected]:spinkube/spin-operator
git pull upstream main
git tag --sign $TAG --message "Release $TAG"
git push upstream $TAG
```

Observe that the [CI run for that tag](https://github.com/spinkube/spin-operator/actions) completed.

Bump the Helm chart versions. See #311 for an example.

Next, you'll need to update the documentation:

```console
git clone [email protected]:spinkube/documentation
cd documentation
```

Change all references to the previous version to the new version, then run:

```console
npm install
npm run generate:crd:reference
```

Contribute those changes and open a PR.

As an optional step, you can run a set of smoke tests to ensure the latest release works as expected.

Finally, announce the new release on the #spinkube CNCF Slack channel.

0 comments on commit 42ee070

Please sign in to comment.