-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
document the release workflow and associated tooling
- Loading branch information
1 parent
85a027c
commit 96869f4
Showing
1 changed file
with
12 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|