Skip to content

Commit

Permalink
docs: Improve RELEASE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
trallnag committed Mar 25, 2023
1 parent f8b7382 commit 7d0d9bb
Showing 1 changed file with 21 additions and 18 deletions.
39 changes: 21 additions & 18 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ This document describes the release process and is targeted at maintainers.
## Preparation

Pick a name for the new release. It must follow
[Semantic Versioning](https://semver.org). For example `1.2.0` or `5.10.7`.
[Semantic Versioning](https://semver.org):

```
```shell
VERSION=1.0.1
```

Expand All @@ -21,43 +21,46 @@ release to a new section with an appropriate title for the release. Should the

## Trigger

Stage and commit the changes. Remember to sign the commit.
Commit the changes. Make sure to sign the commit:

```
```shell
git add CHANGELOG.md
git commit -S -m "chore: Prepare release v$VERSION"
git log --show-signature -1
```

Tag the commit with an annotated and signed tag.
Push changes:

```shell
git push origin master
```

Check
[workflow runs](https://github.com/trallnag/kubestatus2cloudwatch/actions?query=branch%3Amaster)
in GitHub Actions and ensure everything is fine.

Tag the latest commit with an annotated and signed tag:

```shell
git tag -s v$VERSION -m ""
git show v$VERSION
```

Make sure that the tree looks good.
Make sure that the tree looks good:

```
```shell
git log --graph --oneline --all -n 5
```

Push changes on the master branch.
Push the tag itself:

```
git push origin master
```

Check workflow runs in GitHub Actions and ensure everything is fine.

Now push the tag itself.

```
```shell
git push origin v$VERSION
```

This triggers the release workflow which will build binaries, build and push
container images, and draft a GitHub release.
container images, and draft a GitHub release. Monitor the
[release workflow run](https://github.com/trallnag/kubestatus2cloudwatch/actions/workflows/release.yaml).

## Wrap Up

Expand Down

0 comments on commit 7d0d9bb

Please sign in to comment.