Skip to content

Commit

Permalink
document the release workflow and associated tooling
Browse files Browse the repository at this point in the history
  • Loading branch information
danielpodwysocki-gini committed Oct 16, 2024
1 parent 85a027c commit 96869f4
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## release workflow

We use a combination of [GitHub Actions](https://docs.github.com/en/actions) and [goreleaser](https://goreleaser.com/)

Configurations for those shouldn't generally require adjusting, but if they do, they are found underneath `.github` and `.goreleaser.yml`

In order to release:

1) Merge your changes to master
2) Push a tag following semVer. If you are unsure of what version to assign, you can find the concepts described here: https://semver.org/
3) Verify the github action defined in .github/ completed and a new release is available. You can see the status in the github web UI.

0 comments on commit 96869f4

Please sign in to comment.