Publishing releases
How server releases become Docker images, and where app releases are built. For maintainers.
Server releases are published as three Docker images built from the same commit: lspsoftware/openbeacon-backend, lspsoftware/openbeacon-scheduled-jobs and lspsoftware/openbeacon-map-tiles.
Release Docker images
- Merge a pull request that bumps
serverVersion. - Run the Release Docker images GitHub Actions workflow by hand from
main. - The workflow builds all three images and pushes them to Docker Hub, tagged with
serverVersion. - Once all three are pushed, it points
latest-stableat that version.
Self-hosters pull latest-stable, or a version tag to stay on one release.
- The workflow fails if that version was already released from a different commit, so bump
serverVersionfor every release. - Re-running it for the same commit skips the builds when all three images are already on Docker Hub.
- It never moves
latest-stableto an older version, so re-running an old run can't roll servers back. - The run summary lists the version, commit and image digests.
The Update Docker Hub descriptions workflow publishes the image pages on Docker Hub from .github/dockerhub.
Roll back
Revert the change on main, bump serverVersion and release it. Rolling back doesn't undo database migrations, so every migration must work with the previous release while servers upgrade.
Before you release
- Check the release notes say if self-hosters need to change any settings.
- If the release raises
minServerApiCompatibilityLevelfor a new app, release the server before the app. See API compatibility.
The Android app
App releases are built and signed on a maintainer's machine and uploaded to Google Play by hand. See Android release builds.