Skip to content

Releasing

Pavel Erokhin edited this page Oct 25, 2026 · 2 revisions

A release goes to two places: GitHub, by a workflow, and grafana.com, by hand.

1. GitHub

  1. Make sure CHANGELOG.md has a “## X.Y.Z” section for the new version.
  2. Run the “Release” workflow: gh workflow run release.yml -R MairwunNx/minecraft-grafana -f version=X.Y.Z, or Actions → Release → Run workflow.
  3. Watch it: gh run watch.

The workflow:

  • refuses a version that's already tagged, and runs scripts/check.py;
  • takes the version's changelog section as the release notes (or the “changelog” field, when filled);
  • writes minecraft.json: dashboard.json with “(vX.Y.Z)” at the end of its description, so an imported copy says which release it is;
  • publishes the GitHub release vX.Y.Z with minecraft.json attached. releases/latest/download/minecraft.json always reaches the newest;
  • with “moonlands” on (the default), starts ship-plugin.yml in MairwunNx/minecraft, which copies the dashboard over Moonlands' file. That step needs the FAMILY_ACTIONS_TOKEN secret.

Never delete or re-tag a published release. Fix a mistake with the next version.

2. grafana.com

grafana.com has no API for new revisions, so each release goes up on the website. The dashboard is 25941 in the organization mairwunnx.

  1. Download minecraft.json from the new GitHub release.
  2. Sign in to grafana.com and open grafana.com/grafana/dashboards/25941.
  3. Switch to the Revisions tab and press Upload revision. Pick minecraft.json. The revision's description stays empty: grafana.com reads it from a v1 dashboard's top level, and the v2 file keeps it in spec.
  4. When the README or the screenshot changed, open https://grafana.com/orgs/mairwunnx/dashboards/25941/edit and update them. The README there is a shorter take on the repository's README, with the warning about keeping the dashboard private.
  5. Check what stuck: curl https://grafana.com/api/dashboards/25941 shows the newest revision and the README.

The site's forms ignore values a script sets. Click into a field, type, and press Tab before Save.

Clone this wiki locally