Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
clabby committed Jan 25, 2025
1 parent a111456 commit ffda205
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,18 @@ docker buildx bake \

## Cutting a Release (for maintainers / forks)

To cut a release for any of the targets, first cut a new annotated tag for the target like so:
To cut a release of the docker image for any of the targets, cut a new annotated tag for the target like so:

```sh
# Example formats:
# - `kona-host-v0.1.0-beta.8`
# - `cannon-builder-v1.2.0`
TAG="<target_name>-<version>"
# - `kona-host/v0.1.0-beta.8`
# - `cannon-builder/v1.2.0`
TAG="<target_name>/<version>"
git tag -a $TAG -m "<tag description>" && git push origin tag $TAG
```

Then, navigate over to the ["Build and Publish Docker Image"](https://github.com/op-rs/kona/actions/workflows/docker.yaml) action.
From there, run a `workflow_dispatch` trigger, select the tag you just pushed, and then finally select the image to release.
To run the workflow manually, navigate over to the ["Build and Publish Docker Image"](https://github.com/op-rs/kona/actions/workflows/docker.yaml)
action. From there, run a `workflow_dispatch` trigger, select the tag you just pushed, and then finally select the image to release.

Or, if you prefer to use the `gh` CLI, you can run:
```sh
Expand Down

0 comments on commit ffda205

Please sign in to comment.