@@ -65,7 +65,7 @@ mise has tasks for:
6565- Running unit tests (` test:unit ` )
6666- Running integration tests (` test:integration ` , ` test:integration:* ` )
6767- Building binaries (` build:binary ` ) and Docker images (` build:docker ` )
68- - Publishing release artifacts (` release ` )
68+ - Creating GitHub releases (` release ` ) — see [ Releasing ] ( #releasing )
6969
7070These are the important files in the repo:
7171
@@ -741,3 +741,48 @@ Struct definitions make error message strings slightly clearer.
741741
742742Note: not all errors do this at the moment, and we will change over time.
743743
744+ ## Releasing
745+
746+ Releases are published via GitHub Actions when a GitHub release is created.
747+
748+ ### Using mise (recommended)
749+
750+ ``` bash
751+ mise run release v2.1.9
752+ ```
753+
754+ This will:
755+ 1 . Create a git tag for the version
756+ 2 . Push the tag to origin
757+ 3 . Create a GitHub release with auto-generated notes
758+ 4 . Trigger the release workflow which builds and publishes Docker images
759+
760+ ### Manual release
761+
762+ If you need more control over the release process:
763+
764+ ``` bash
765+ # Create and push the tag
766+ git tag v2.1.9
767+ git push origin v2.1.9
768+
769+ # Create the GitHub release
770+ gh release create v2.1.9 --generate-notes
771+ ```
772+
773+ ### Re-releasing a version
774+
775+ If a release fails and you need to re-release the same version:
776+
777+ ``` bash
778+ # Delete the GitHub release
779+ gh release delete v2.1.9 --yes
780+
781+ # Delete the tag (local and remote)
782+ git tag -d v2.1.9
783+ git push origin :refs/tags/v2.1.9
784+
785+ # Create the release again
786+ mise run release v2.1.9
787+ ```
788+
0 commit comments