Skip to content

Commit

Permalink
docs: document how to create a release
Browse files Browse the repository at this point in the history
  • Loading branch information
fho committed Oct 23, 2024
1 parent f3bc264 commit 7df35af
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Release

## How to Create a Release

1. Create a git tag for the new release

```sh
git tag v<MY-VERSION>
```

**ADVISE**: Do not push the tag. Instead let it be created by GitHub when
removing the draft status. This allows to eventually recreate + delete the
draft release without having the tags already on the on the git remote.

2. Import our GPG signing private key:
- retrieve the GPG private key password and store it in an environment
variable:

```sh
export GPG_PASSWORD="$(vault read -field=master-priv-key-password secret/gpg-key-platform)"
```

- import the signing key:

```sh
vault read -field=subkey-signing-priv-key secret/gpg-key-platform | \
gpg --batch --pinentry-mode loopback --passphrase "$GPG_PASSWORD" --import
```

3. Set the `GITHUB_TOKEN` environment variable:

```sh
export GITHUB_TOKEN=<MY-TOKEN>
```

4. Run goreleaser

```sh
goreleaser release
```

5. Review the created draft release on
[GitHub](https://github.com/simplesurance/registrator/releases) and publish
it.

0 comments on commit 7df35af

Please sign in to comment.