Merge pull request #1209 from ludovic111/feat/update-channels
🤖 Agent: merged. Nightly/Stable update channels (Ludovic's request 2026-10-22): Settings choice, nightly train 5/20 min, one stable promotion a day at 20:00 UTC, Nightly launchers check every 30 min. verify passes on b197682d (main merged in: Settings keeps update_channel and #1185's ping_notice_seen). Ships in launcher@0.2.0; launcher.yml stays disabled until #1132.
This commit is contained in:
+29
-18
@@ -2,8 +2,9 @@
|
||||
|
||||
How a change gets from a pull request to players: the checks a pull request passes, how it merges, and the
|
||||
automatic releases that follow. Releases are automatic and frequent so the latest Horizon is always playable.
|
||||
Each one goes out as a **beta** and becomes **stable** 6 hours later unless something holds it back
|
||||
([Channels](#channels)): launchers and servers install stable builds unless their owner turns betas on.
|
||||
Each one goes out as a **beta**, which launchers on the **Nightly** channel install at once, and becomes **stable** in
|
||||
the next daily promotion unless something holds it back ([Channels](#channels)): launchers and servers install
|
||||
stable builds unless their owner picks Nightly.
|
||||
|
||||
## Pull request checks
|
||||
|
||||
@@ -93,7 +94,7 @@ flowchart LR
|
||||
main --> mainchecks{"checks on main"}
|
||||
mainchecks -- green --> decide{"decide<br/>tools/release_train.py"}
|
||||
cron(["every hour :17"]) --> decide
|
||||
decide -- "player-facing PRs settled 15 min<br/>(or waiting 1 h), or release-now" --> build
|
||||
decide -- "player-facing PRs settled 5 min<br/>(or waiting 20 min), or release-now" --> build
|
||||
decide -- otherwise --> wait(["wait"])
|
||||
subgraph build["build, in parallel"]
|
||||
linux["Linux x86_64<br/>GitHub ubuntu-22.04"]
|
||||
@@ -101,8 +102,8 @@ flowchart LR
|
||||
mac["macOS arm64<br/>Mac mini runner<br/>+ offscreen game run"]
|
||||
end
|
||||
build --> publish["publish vX.Y.Z as a beta<br/>notes from the merged PRs"]
|
||||
publish --> beta(["launchers with Beta builds on install it"])
|
||||
publish --> promote{"promote.yml, every 30 min:<br/>6 h old, smoke test, no release-blocker"}
|
||||
publish --> beta(["launchers on Nightly install it"])
|
||||
publish --> promote{"promote.yml, daily at 20:00 UTC:<br/>6 h old by then, smoke test, no release-blocker"}
|
||||
promote --> stable["stable and latest<br/>notes since the last stable"]
|
||||
stable --> launcher(["every launcher and server installs it"])
|
||||
stable --> kira(["Kira posts it;<br/>pings only with ### New"])
|
||||
@@ -117,9 +118,10 @@ commits) since the last **published** game release:
|
||||
`xtask/`, `packaging/`, `Cargo.toml`, `Cargo.lock`, `research-lock.json`, or an exporter `horizon-prepare`
|
||||
compiles (the `mods/horizon/src/test/java/dev/horizonlab/parity/*.java` files its sources name). Markdown never
|
||||
counts.
|
||||
- It releases when at least one pull request counts and the newest of them merged at least 15 minutes ago, so a burst
|
||||
of merges becomes one release; if merges never pause, it releases once the oldest has waited an hour. There is no
|
||||
minimum time between releases: every settled player-facing change ships.
|
||||
- It releases when at least one pull request counts and the newest of them merged at least 5 minutes ago, so a wave
|
||||
of merges becomes one release; if merges never pause, it releases once the oldest has waited 20 minutes. There is
|
||||
no minimum time between releases: every settled player-facing change ships, limited only by the release already
|
||||
building. That is the Nightly channel, many releases a day.
|
||||
- A pull request labelled `release-now` (a crash or a blocker) releases at once.
|
||||
- A pull request labelled `skip-release` (work players don't see) doesn't count and isn't listed in the notes.
|
||||
- One release at a time (concurrency group `game-release`); a run that finds nothing new does nothing.
|
||||
@@ -184,15 +186,23 @@ Kira posts every published release in #releases and pings the releases role only
|
||||
### Channels
|
||||
|
||||
Every game release is published as a **beta**, a GitHub pre-release, so GitHub's *latest* release stays the last
|
||||
**stable** one. Launchers and `horizon-server update` install stable builds by default (the launcher's Settings
|
||||
has a "Beta builds" switch; `horizon-server update --version <beta>` takes one by name), and Kira announces a release
|
||||
**stable** one. The launcher's Settings has an **Updates** choice of two channels (`update_channel` in its
|
||||
`settings.json`, `horizon-launcher update-channel`):
|
||||
|
||||
- **Stable**, the default: a tested build about once a day, the betas promoted below.
|
||||
- **Nightly**: every beta as soon as it is built, many times a day; it can break. "Nightly" is a name, not a
|
||||
schedule. An open launcher looks for releases every 30 minutes on Nightly (4 hours on Stable). Launchers from before 0.2 had a "Beta builds" switch instead; on, it reads as Nightly.
|
||||
|
||||
`horizon-server update` installs stable builds (`--version <beta>` takes one by name), and Kira announces a release
|
||||
when it becomes stable: Discord's #releases only ever shows stable ones.
|
||||
|
||||
`.github/workflows/promote.yml` runs `tools/release_channels.py promote` every 30 minutes. It promotes the newest
|
||||
`.github/workflows/promote.yml` runs `tools/release_channels.py promote` once a day at 20:00 UTC (21:00 in Paris in
|
||||
winter time, 22:00 in summer), with retries until 21:37 for a run GitHub starts late or skips. It promotes the newest
|
||||
beta that
|
||||
|
||||
- is newer than the stable release,
|
||||
- has been out 6 hours,
|
||||
- had been out 6 hours at 20:00 UTC (published by 14:00 UTC that day; one published later waits for the next day),
|
||||
so every run of the evening picks the same beta and stable moves once a day,
|
||||
- passed its release smoke test: the macOS build attaches `smoke-test.json` (the offscreen game run's report) only
|
||||
when the game drew a world on the Mac mini, so a release built while `MAC_RUNNER` sends macOS to GitHub waits
|
||||
for a hand,
|
||||
@@ -204,7 +214,8 @@ beta that
|
||||
Nothing older than the stable release is ever promoted, not even with `force`: GitHub's latest release is what
|
||||
`horizon-server update` and `install.sh` download, so it only moves forward.
|
||||
|
||||
When the oldest beta newer than the stable release has waited 24 hours, promote.yml opens an issue titled
|
||||
When the oldest beta newer than the stable release has waited 30 hours (it missed a daily promotion it was due for;
|
||||
on a normal day a beta waits at most that long and is promoted), promote.yml opens an issue titled
|
||||
"Promotion to stable has stalled" with the reason from the last check (a blocker left open, smoke tests not
|
||||
running). It closes itself after the next promotion.
|
||||
|
||||
@@ -213,12 +224,12 @@ release (`release_train.py notes --stable`), so players who skipped the betas se
|
||||
betas. By hand, from a phone too (GitHub app: Actions, promote, Run workflow):
|
||||
|
||||
```sh
|
||||
gh workflow run promote -f tag=v2026.10.19.03 # that beta now: no 6-hour wait, still no blocker
|
||||
gh workflow run promote -f tag=v2026.10.19.03 -f force=true # even blocked or without a smoke test
|
||||
gh workflow run promote -f dry_run=true # what would be promoted now
|
||||
gh workflow run promote -f tag=v0.2.3 # that beta now: no wait for 20:00, still no blocker
|
||||
gh workflow run promote -f tag=v0.2.3 -f force=true # even blocked or without a smoke test
|
||||
gh workflow run promote -f dry_run=true # what would be promoted now
|
||||
```
|
||||
|
||||
A beta's notes cover only what changed since the release before it (beta or stable), and say it is a beta.
|
||||
A beta's notes cover only what changed since the release before it (beta or stable), and say it is a nightly build.
|
||||
`release_train.py decide` counts pull requests from the newest release of either channel, so betas don't
|
||||
release the same changes again.
|
||||
|
||||
@@ -308,7 +319,7 @@ and by hand; pushes to `launcher` and `launcher-*` branches only build.
|
||||
|
||||
- `tools/release_train.py decide --kind launcher` counts the pull requests merged since the last published
|
||||
launcher release that changed those paths (not `launcher/links.json`, which the launcher reads from main, nor
|
||||
tests or Markdown), with the same settling rule (15 minutes, at most an hour), `release-now`, `skip-release` and `RELEASES_PAUSED`.
|
||||
tests or Markdown), with the same settling rule (5 minutes, at most 20), `release-now`, `skip-release` and `RELEASES_PAUSED`.
|
||||
- The tag is `launcher@X.Y.Z` on the release line (`launcher@0.2.0` first; the game and the launcher count their
|
||||
patches separately). Without `.github/release-line.txt`, `launcher-vX.Y.Z`: the patch after the last launcher tag,
|
||||
or the next minor (`X.Y+1.0`) when one of those pull requests is labelled `feature`. `launcher-v0.2.0` was taken
|
||||
|
||||
+5
-5
@@ -38,7 +38,7 @@ and some are waiting for Ludovic:
|
||||
| Private vulnerability reporting | **Live** (see the end of this page). |
|
||||
| Signed checksums on releases | **Live** for new releases (#1011): the `release` environment holds the key, and its public half is in `release-keys.txt` (#1023). Releases from before then are unsigned. |
|
||||
| Launchers and servers checking signatures | **Not yet**: #1014 waits as a draft until a signed stable game release and a signed launcher release exist. Until then they trust GitHub's checksum, as before. |
|
||||
| Beta, then stable | **Not yet** (#1012): every release still goes straight to every player. The launcher's "Beta builds" switch is already there (#1013), and has no betas to offer yet. |
|
||||
| Beta, then stable | **Live** (#1012): every release is first a beta. The launcher's Updates setting picks Stable (the default) or Nightly (the betas). |
|
||||
| Reports marked suspicious | **Partly**: the scan of Discord for agents does it. Kira's issues do it once its pull request merges. |
|
||||
| Code owners' review of the pipeline | **Not yet**: `.github/CODEOWNERS` and its protection (#1015) wait for the App, below. Until then pipeline changes merge like any other once `verify` passes. |
|
||||
| Agents on their own GitHub App | **Not yet**: prepared, waiting for Ludovic to create it. Agents still use his account. |
|
||||
@@ -54,10 +54,10 @@ and some are waiting for Ludovic:
|
||||
the only `verify` a change can have is one that ran. Main requires it, from GitHub Actions only, for everyone,
|
||||
admins included.
|
||||
- **Beta, then stable.** Every release is first a **beta**. It becomes **stable**, the version launchers and
|
||||
servers install by themselves, only after it has been out 6 hours and passed its smoke test (the game started and
|
||||
drew a world on the Mac mini), and only while no issue labelled `release-blocker` is open. If no beta has
|
||||
become stable for a day, an issue says so. Players who want the
|
||||
newest builds at once turn on "Beta builds" in the launcher's Settings. Discord announces stable releases only.
|
||||
servers install by themselves, in the daily promotion (20:00 UTC), only after it has been out 6 hours and passed its
|
||||
smoke test (the game started and drew a world on the Mac mini), and only while no issue labelled `release-blocker`
|
||||
is open. If a beta misses a promotion it was due for, an issue says so. Players who want the newest builds at once
|
||||
pick **Nightly** under Updates in the launcher's Settings. Discord announces stable releases only.
|
||||
- **Signed updates.** Each release carries a list of its files' checksums, signed with Horizon's release key. The
|
||||
launcher (for the game and for itself) and `horizon-server update` check that signature against the public key
|
||||
built into them, then check the download against the list. Anything unsigned, signed with another key, signed
|
||||
|
||||
+8
-5
@@ -22,9 +22,10 @@ game and the launcher of the 0.2 line.
|
||||
0.2. A `feature` label no longer bumps anything: it only lists the change under **New**.
|
||||
- **Patch releases** are every release the train makes: the patch after the newest release tagged on the line, game
|
||||
and launcher counted separately (the game releases more often, so `v0.2.14` can go with `launcher@0.2.3`).
|
||||
- **Betas** are not separate tags. As before, every game release is published as a GitHub pre-release (a beta) under
|
||||
its final tag and promoted in place to stable after 6 hours ([Channels](release-flow.md#channels)). `v0.2.4` is
|
||||
the same build whether it is still a beta or already stable.
|
||||
- **Betas** are not separate tags. As before, every game release is published as a GitHub pre-release (a beta, what
|
||||
the launcher's Nightly channel installs) under its final tag and promoted in place to stable in the daily
|
||||
promotion at 20:00 UTC, once it has been out 6 hours ([Channels](release-flow.md#channels)). `v0.2.4` is the same
|
||||
build whether it is still a beta or already stable.
|
||||
- **Pre-release tags** (`v0.3.0-rc.1`, `v0.3.0-beta.2`) are semver's and are reserved for a hand-made preview of a
|
||||
new line; the train never makes them. Every reader orders them before their release and after the release
|
||||
before (`v0.2.9` < `v0.3.0-beta.1` < `v0.3.0-rc.1` < `v0.3.0`).
|
||||
@@ -125,7 +126,8 @@ Run by the orchestrator, in this order. Until step 3, nothing is published.
|
||||
makes it *latest*. Do not force it (`promote` with `force=true`): it carries about 43 player-facing pull requests
|
||||
from the freeze and needs its beta like any release. Check it is *latest*:
|
||||
`gh api repos/ludovic111/horizon/releases/latest --jq .tag_name`.
|
||||
5. Only then mark the switch pull request (#1132) ready and merge it (`.github/release-line.txt` = `0.2`, and the
|
||||
5. Only then merge the update channels pull request (the launcher's Stable and Nightly, the daily promotion), then
|
||||
mark the switch pull request (#1132) ready and merge it (`.github/release-line.txt` = `0.2`, and the
|
||||
docs that talk about 0.2). On the next run, about 10 minutes, the train publishes `v0.2.0` as a beta and
|
||||
`launcher@0.2.0`, both "the first release of 0.2", built from the same code as the bridges plus that pull request.
|
||||
6. Check the way over from an old launcher, in a scratch folder:
|
||||
@@ -135,7 +137,8 @@ Run by the orchestrator, in this order. Until step 3, nothing is published.
|
||||
# with launcher-v0.17.0's binary: update --check --json -> "launcher": "0.2.0", "horizon": "v0.2.0" (with Beta builds on)
|
||||
```
|
||||
and `gh release view v0.2.0 --json assets`, `horizon-server --version` in the Linux server archive.
|
||||
7. `v0.2.0` becomes stable after 6 hours (or `gh workflow run promote -f tag=v0.2.0`). While it is a beta, *latest*
|
||||
7. `v0.2.0` becomes stable in the first daily promotion (20:00 UTC) it has been out 6 hours for (or
|
||||
`gh workflow run promote -f tag=v0.2.0`). While it is a beta, *latest*
|
||||
stays the bridge, so keeping it in beta for longer catches more servers (Ludovic's call). From then on everything
|
||||
is automatic again: `v0.2.1`, `launcher@0.2.1`, ….
|
||||
8. Point Kira, `release-kick` and the heartbeat prompts at the new tags (outside this repository).
|
||||
|
||||
Reference in New Issue
Block a user