Repository navigation
Releasing
A release builds binaries and the image and publishes them in one GitHub Actions run.
-
Write the version's section in
CHANGELOG.md, titled## X.Y.Z. Pick the number by what changed: a patch for fixes, a minor version for features, a major version for a renamed or removed metric. -
Push it to
master. -
Run the “Release” workflow: Actions → Release → Run workflow, or
gh workflow run release.yml -R MairwunNx/minecraft-exporter -f version=X.Y.Z
Its
changelogfield overrides the notes fromCHANGELOG.md. Itsmoonlandsswitch, on by default, ships the release to Moonlands afterwards. -
Watch it:
gh run watch. -
Check the release page and
docker pull ghcr.io/mairwunnx/minecraft-exporter:X.Y.Z.
- Refuses a version that isn't
X.Y.Zor is already tagged, and a version without notes. - Runs
go vetandgo test -race. - Builds binaries for Linux, macOS, and Windows on amd64 and arm64, each archive with
LICENSEandREADME.md, and writeschecksums.txt. - Pushes
ghcr.io/mairwunnx/minecraft-exporterfor amd64 and arm64, taggedX.Y.Z,X.Y,X, andlatest. - Publishes the GitHub release
vX.Y.Zwith the notes and the archives. - Starts
ship-plugin.ymlin MairwunNx/minecraft, which moves Moonlands to the new image. This step needs theFAMILY_ACTIONS_TOKENsecret.
Never delete or re-tag a published release. Finish a half-failed one by hand.
The container package must stay public (GitHub → Packages → minecraft-exporter → Package settings), or docker pull asks for a login.
Port 10059 is the exporter's entry in Prometheus' list of default ports, on the “Default port allocations” page of the Prometheus wiki.
For server owners
For developers