Skip to content

Commit

Permalink
Add release instructions to readme (#92)
Browse files Browse the repository at this point in the history
I had to ask Sam how to release (e.g, do i need to create github tag,
etc).. so am adding instructions to readme for future new peeps (i think
this is correct, I haven't actually cut a new release yet 😅 will update
later if it's wrong)
  • Loading branch information
ElizabethMRichardson authored Mar 12, 2024
1 parent 6a4f5e7 commit b36fc31
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ docker run \

We're happy to accept open-source contributions or feedback. Just open a
PR/issue and we'll get back to you. This repo contains details on
[how to get started with local development](./development.md).
[how to get started with local development](./development.md), and [how to publish a new release](./release.md).
6 changes: 6 additions & 0 deletions release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Releasing

We have a workflow for building & releasing, which can be found in [.github/workflows](.github/workflows).
This uses a tool called [goreleaser](https://goreleaser.com/), which handles most of the release process for us (creating git tag, publishing docker images, etc).

To cut a new release, simply make a new PR with the version updated in [VERSION](cmd/catalog-importer/cmd/VERSION).

0 comments on commit b36fc31

Please sign in to comment.