Merge pull request #5 from dokku/release-docs

docs: document how releases work
dokku · May 16, 2024 · 0f2e7f9 · 0f2e7f9
2 parents 9818920 + 85a5d10
commit 0f2e7f9
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/.github/workflows/bump-release.yml → .github/workflows/bump-version.yml b/.github/workflows/bump-release.yml → .github/workflows/bump-version.yml
diff --git a/README.md b/README.md
@@ -19,3 +19,7 @@ docker run --rm semver --input 0.1.2 --bump patch
 # run it with environment variables
 docker run --rm -e SEMVER_GENERATOR_INPUT=0.1.2 -e SEMVER_GENERATOR_BUMP=patch semver
 ```
+
+## Releasing
+
+Run the `bump-version` Github Actions workflow with the appropriate `bump type`. A docker image will be generated and pushed into GHCR, while the built binaries will be attached to the Github Release associated with the generated tag.