Skip to content

Add a maintenance page and the 🚧 Maintenance workflow - #5

Merged
sunmachine merged 1 commit into
mainfrom
maintenance-page
Nov 5, 2026
Merged

sunmachine merged 1 commit into
mainfrom
maintenance-page

Conversation

@sunmachine

Copy link
Copy Markdown
Collaborator

Summary

Adds a 🚧 Maintenance workflow that puts a maintenance page over the wiki, and takes it down again.

Intent

The wiki had no way to go offline short of deleting versions. Maintainers need to hide it while something is broken, and still be able to deploy and check a fix before bringing it back.

Changes

  • 🚧 Maintenance workflow (.github/workflows/maintenance.yml). It has one checkbox, off by default. Checked puts the page up. Unchecked takes it down, and does nothing if the page isn't up. It shares the deploy's queue and skips the setup action, because it needs neither the game's repositories nor the Python environment.
  • ./deploy maintenance on|off. on moves the whole gh-pages tree into offline/ and puts wiki/maintenance.html at the root as index.html and as 404.html, so every address into the wiki shows the page. off moves the tree under offline/ back to the root unchanged, and the script checks that it did.
  • Deploys while the page is up. Deploy, rollback, list and delete pass mike --deploy-prefix offline and work on the hidden wiki, so a fix can be checked at offline/latest/ before the page comes down. The hidden wiki is out of the way, not private.
  • wiki/maintenance.html. A self-contained page with the NT;RE mark inlined, which follows the reader's light or dark setting. Everything is inline, because it is served at any depth.
  • Docs. README, CONTRIBUTING and AGENTS describe the workflow and the new command.

Tested against a copy of gh-pages: on, off, a no-op deploy, an exact deploy, a rollback, list and a delete dry run while the page was up, then off. The restored tree matched offline/ exactly. ./check passes.

The wiki had no way to go offline short of deleting versions. The new
workflow takes one checkbox, off by default: checked, ./deploy maintenance
on moves the whole gh-pages tree into offline/ and puts
wiki/maintenance.html at the root as index.html and as 404.html, so every
address into the wiki shows the page. Unchecked, ./deploy maintenance off
moves the tree under offline/ back to the root unchanged.

While the page is up, deploy, rollback, list and delete keep working on
the hidden wiki, by passing mike --deploy-prefix offline, so a fix can be
deployed and checked at offline/latest/ before the page comes down. The
hidden wiki is out of the way, not private.

The maintenance tree is built with git plumbing rather than mike, so the
workflow skips the setup action and needs neither the game's repositories
nor the Python environment.
@sunmachine
sunmachine merged commit c390e06 into main Nov 5, 2026
1 check passed
@sunmachine
sunmachine deleted the maintenance-page branch November 5, 2026 19:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant