From 85847bc871f97cc686a9ad171be4ced8f1b8bd90 Mon Sep 17 00:00:00 2001 From: Matt Hughes Date: Fri, 9 Feb 2024 16:00:47 +0000 Subject: [PATCH] Document the release process Since it looks to have worked with our first release[1] [1] https://github.com/utilitywarehouse/manifest-checkers/releases/tag/v0.1.0 --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ff691ca..c95c9bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,12 @@ # Contributing +## Releasing + +Building binaries and generating releases is managed by +[`goreleaser`](https://goreleaser.com/). A new release will be generated when a +tag of the form `v*` is pushed (these should always be semantic version tags +like `v0.1.0`) + ## Linting Linting is handled via `pre-commit`. Follow the [install