Repository navigation
Add a maintenance page and the 🚧 Maintenance workflow - #5
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
.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.onmoves the wholegh-pagestree intooffline/and putswiki/maintenance.htmlat the root asindex.htmland as404.html, so every address into the wiki shows the page.offmoves the tree underoffline/back to the root unchanged, and the script checks that it did.--deploy-prefix offlineand work on the hidden wiki, so a fix can be checked atoffline/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.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 matchedoffline/exactly../checkpasses.