Skip to content

Commit 99efe51

Browse files
authored
Fix release process docs (#8)
1 parent be14fa8 commit 99efe51

2 files changed

Lines changed: 10 additions & 7 deletions

File tree

.github/workflows/release.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Release
1+
name: Publish
22

33
on:
44
push:
@@ -33,9 +33,10 @@ jobs:
3333
with:
3434
images: ghcr.io/${{ github.repository }}
3535
tags: |
36+
type=raw,value=latest,enable=${{ !contains(github.ref_name, '-') }}
37+
type=sha,prefix=sha-
3638
type=ref,event=tag
3739
type=semver,pattern={{version}}
38-
type=raw,value=latest,enable=${{ !contains(github.ref_name, '-') }}
3940
4041
- name: Log in to GitHub Container Registry
4142
uses: docker/login-action@v3

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# mcserver
22

33
[![CI](https://github.com/hauntedmc/mcserver/actions/workflows/ci.yml/badge.svg)](https://github.com/hauntedmc/mcserver/actions/workflows/ci.yml)
4-
[![Release](https://github.com/hauntedmc/mcserver/actions/workflows/release.yml/badge.svg)](https://github.com/hauntedmc/mcserver/actions/workflows/release.yml)
4+
[![Publish](https://github.com/hauntedmc/mcserver/actions/workflows/release.yml/badge.svg)](https://github.com/hauntedmc/mcserver/actions/workflows/release.yml)
55
[![License: AGPL v3](https://img.shields.io/badge/license-AGPL%20v3-blue.svg)](./LICENSE)
66
[![Issues](https://img.shields.io/github/issues/hauntedmc/mcserver)](https://github.com/hauntedmc/mcserver/issues)
77
[![Pull Requests](https://img.shields.io/github/issues-pr/hauntedmc/mcserver)](https://github.com/hauntedmc/mcserver/pulls)
@@ -23,13 +23,15 @@ This repository packages a small, auditable container image for Minecraft server
2323
- Downloads or refreshes `server.jar` on startup from `JAR_URL`.
2424
- Stores server state under a mounted `/data` volume.
2525
- Exposes straightforward JVM tuning through environment variables.
26-
- Publishes multi-arch images to GitHub Container Registry.
26+
- Publishes multi-arch images publicly to GitHub Container Registry.
2727
- Ships with CI, contribution guidance, issue templates, and release automation.
2828

2929
## Quick start
3030

3131
### Pull the published image
3232

33+
Pushing a version tag such as `v1.2.3` publishes `ghcr.io/hauntedmc/mcserver:latest`, `ghcr.io/hauntedmc/mcserver:v1.2.3`, `ghcr.io/hauntedmc/mcserver:1.2.3`, and a `sha-<commit>` tag for that release commit.
34+
3335
```bash
3436
docker pull ghcr.io/hauntedmc/mcserver:latest
3537
```
@@ -106,9 +108,9 @@ ctr -n=k8s.io i import mcserver.tar
106108
## Release process
107109

108110
1. Update changes on the default branch.
109-
2. Run `./update_version.sh <major|minor|patch>`.
110-
3. Push the branch and the new tag.
111-
4. GitHub Actions will build and publish a multi-architecture image and create a GitHub release for that tag.
111+
2. Run `./update_version.sh <major|minor|patch>` to bump `version.txt`, create the release commit, and create the local Git tag.
112+
3. Push the branch and the new tag using the command printed by the script.
113+
4. GitHub Actions will publish the public GHCR image tags for that release and create a GitHub release.
112114

113115
## Open source and community
114116

0 commit comments

Comments
 (0)