Skip to content

Releasing

Pavel Erokhin edited this page Nov 9, 2026 · 2 revisions

A release builds binaries and the image and publishes them in one GitHub Actions run.

  1. 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.

  2. Push it to master.

  3. Run the “Release” workflow: Actions → Release → Run workflow, or

    gh workflow run release.yml -R MairwunNx/minecraft-exporter -f version=X.Y.Z

    Its changelog field overrides the notes from CHANGELOG.md. Its moonlands switch, on by default, ships the release to Moonlands afterwards.

  4. Watch it: gh run watch.

  5. Check the release page and docker pull ghcr.io/mairwunnx/minecraft-exporter:X.Y.Z.

What the workflow does

  1. Refuses a version that isn't X.Y.Z or is already tagged, and a version without notes.
  2. Runs go vet and go test -race.
  3. Builds binaries for Linux, macOS, and Windows on amd64 and arm64, each archive with LICENSE and README.md, and writes checksums.txt.
  4. Pushes ghcr.io/mairwunnx/minecraft-exporter for amd64 and arm64, tagged X.Y.Z, X.Y, X, and latest.
  5. Publishes the GitHub release vX.Y.Z with the notes and the archives.
  6. Starts ship-plugin.yml in MairwunNx/minecraft, which moves Moonlands to the new image. This step needs the FAMILY_ACTIONS_TOKEN secret.

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.

Clone this wiki locally