docs: get the Pages setup steps into an order that works

The branch is created by the first release, and a branch that does not exist
cannot be selected in the Pages settings - so telling somebody to set Pages
first sends them into a wall. Release first, point Pages at it second.

Also says what happens if Pages is left on main: the source tree gets served
at the address the install instructions name, and every one of them 404s.
This commit is contained in:
Felitendo committed 2026-08-24 11:08:05 +02:00
1 parent c31c7b92e5
commit 21e29d99c3
1 file changed
+14 -4
+14 -4
View File
@@ -63,13 +63,23 @@ gpg --armor --export-secret-keys 'middleclick-autoscroll repository' \
| gh secret set GPG_PRIVATE_KEY
```
Then, in the repository settings, set **Pages** to deploy from a branch and
pick `gh-pages` at the root. The branch is created by the first release that
runs with the key in place.
Without the secret the workflow still builds both packages and attaches them to
the release; it says so in the log and leaves the repositories alone.
## Pointing Pages at it, once — and in this order
The `gh-pages` branch does not exist until a release has put something on it,
and a branch that does not exist cannot be picked in the Pages settings. So:
1. Set the secret, above.
2. Tag a release. The workflow creates the branch and fills it.
3. *Then* set **Pages** to deploy from a branch and pick `gh-pages` at the
root.
Doing it the other way round is a wall, and leaving Pages pointed at `main`
serves the source tree at the address the install instructions name — the key
and the indexes are 404 and nothing installs.
## What users end up with
The public key is published as `KEY.gpg` beside the repositories, and the