Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: "🚀 Deploy"

# Publish main to https://sunmachine.github.io/ntre-wiki/ as a new version. Run it from
# Publish main to https://neotokyorebuild.github.io/ntre-wiki/ as a new version. Run it from
# the Actions tab: it deploys the next minor version after latest, unless you choose
# major or type an exact version.
on:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/rollback.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: "⏪ Rollback"

# Point https://sunmachine.github.io/ntre-wiki/latest/ at an earlier deployed version.
# Point https://neotokyorebuild.github.io/ntre-wiki/latest/ at an earlier deployed version.
# Nothing is rebuilt and main isn't changed, so the next 🚀 Deploy publishes main again:
# fix or revert the change on main before then.
on:
Expand Down
4 changes: 2 additions & 2 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Set up with `./setup`: it creates `wiki/.venv` and records the `neo` and `neoAss

## Deploying

The wiki is published at https://sunmachine.github.io/ntre-wiki/, from the `gh-pages` branch of `sunmachine/ntre-wiki`. The 🚀 Deploy workflow runs `./deploy`, which has `mike` build `main` into a new version folder (by default the next minor version after the one `latest` points at, skipping versions that already exist; the next major when chosen; or an exact version, which must be M.m), points `latest` and the site's root at it, and pushes. It refuses a dirty tree, a commit that isn't on `main` in `sunmachine/ntre-wiki`, a failing `./check`, symlinks, and changes outside the new version, `latest/` and mike's root files. The published address is set only in `deploy`: don't hard-code it in `mkdocs.yml` or in pages. Old versions are removed only by hand, locally: `./deploy delete` lists what goes and what stays, asks before deleting, and refuses the version `latest` points at. Never delete versions without the maintainer's say-so. Never use `mkdocs gh-deploy`: it replaces the whole branch, and every earlier version with it. GitHub Pages rejects symlinks, which is why `mkdocs.yml` sets mike's `alias_type: copy`. Deploying publishes to a public site: do it only when asked.
The wiki is published at https://neotokyorebuild.github.io/ntre-wiki/, from the `gh-pages` branch of `NeotokyoRebuild/ntre-wiki`. The 🚀 Deploy workflow runs `./deploy`, which has `mike` build `main` into a new version folder (by default the next minor version after the one `latest` points at, skipping versions that already exist; the next major when chosen; or an exact version, which must be M.m), points `latest` and the site's root at it, and pushes. It refuses a dirty tree, a commit that isn't on `main` in `NeotokyoRebuild/ntre-wiki`, a failing `./check`, symlinks, and changes outside the new version, `latest/` and mike's root files. The published address is set only in `deploy`: don't hard-code it in `mkdocs.yml` or in pages. Old versions are removed only by hand, locally: `./deploy delete` lists what goes and what stays, asks before deleting, and refuses the version `latest` points at. Never delete versions without the maintainer's say-so. Never use `mkdocs gh-deploy`: it replaces the whole branch, and every earlier version with it. GitHub Pages rejects symlinks, which is why `mkdocs.yml` sets mike's `alias_type: copy`. Deploying publishes to a public site: do it only when asked.

A ruleset on `main` requires a pull request that passes 🏗 CI, and blocks force pushes and deletion. No approval is needed, except that `.github/CODEOWNERS` makes the maintainer's approval required for changes to `.github/`, `deploy`, `check` and `setup`; add any new file the workflows run to it. A ruleset on `gh-pages` blocks force pushes. Contributors merge their own PRs once CI passes. The maintainer, and agents working with them, push to `main` directly through the admin bypass.

Expand Down Expand Up @@ -62,4 +62,4 @@ The wiki engine is MkDocs Material (decided 2026-11-01). Material reaches end of

- Data model for game facts
- Content and media licensing (currently all rights reserved)
- Hosting: GitHub Pages, from the `gh-pages` branch of `sunmachine/ntre-wiki`, for now
- Hosting: GitHub Pages, from the `gh-pages` branch of `NeotokyoRebuild/ntre-wiki`, for now
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A wiki for [NEOTOKYO Rebuild](https://github.com/NeotokyoRebuild/neo). Pre-alpha
## Quick Start

```sh
git clone https://github.com/sunmachine/ntre-wiki.git
git clone https://github.com/NeotokyoRebuild/ntre-wiki.git
cd ntre-wiki
./setup
```
Expand Down Expand Up @@ -36,7 +36,7 @@ See [`CONTRIBUTING.md`](CONTRIBUTING.md) for how to edit pages, add one, or chan

## Deploy

The wiki is published at https://sunmachine.github.io/ntre-wiki/. Maintainers deploy it with the 🚀 Deploy workflow, from the Actions tab. Each run publishes `main` as the next minor version after `latest` (0.3 → 0.4, skipping any version that already exists) and makes it `latest`. Choose `major` for the next major version (0.4 → 1.0), or type an exact version in M.m form, such as `0.4`. Earlier versions stay in the header's version menu. A run that would publish the same site `latest` already serves stops without deploying.
The wiki is published at https://neotokyorebuild.github.io/ntre-wiki/. Maintainers deploy it with the 🚀 Deploy workflow, from the Actions tab. Each run publishes `main` as the next minor version after `latest` (0.3 to 0.4, skipping any version that already exists) and makes it `latest`. Choose `major` for the next major version (0.4 to 1.0), or type an exact version in M.m form, such as `0.4`. Earlier versions stay in the header's version menu. A run that would publish the same site `latest` already serves stops without deploying.

To undo a bad deploy, run the ⏪ Rollback workflow with the version to go back to (such as `0.2`). It points `latest` at that version without rebuilding anything. It doesn't change `main`, so fix or revert the change there before the next deploy, which publishes `main` again.

Expand Down
12 changes: 6 additions & 6 deletions deploy
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env bash
# Publish the wiki to https://sunmachine.github.io/ntre-wiki/, and manage the versions on
# the gh-pages branch of sunmachine/ntre-wiki. The 🚀 Deploy workflow runs the first two.
# Publish the wiki to https://neotokyorebuild.github.io/ntre-wiki/, and manage the versions on
# the gh-pages branch of NeotokyoRebuild/ntre-wiki. The 🚀 Deploy workflow runs the first two.
#
# ./deploy [minor] [TITLE] deploy the next minor version after latest: 0.3 -> 0.4
# ./deploy major [TITLE] deploy the next major version after latest: 0.4 -> 1.0
Expand All @@ -15,7 +15,7 @@
# with latest at 0.1 and 0.2 deployed, the next minor is 0.3. An exact version must be
# M.m: two whole numbers without leading zeros, such as 0.4 or 1.10.
#
# A deploy only runs from a clean tree whose HEAD is on main in sunmachine/ntre-wiki, and
# A deploy only runs from a clean tree whose HEAD is on main in NeotokyoRebuild/ntre-wiki, and
# only after ./check passes. A new version identical to what `latest` serves is not
# deployed. The ⏪ Rollback workflow runs rollback. Delete never touches
# the version `latest` points at. The published address is set here and nowhere else
Expand All @@ -26,9 +26,9 @@ cd "$(dirname "$0")"
DRY_RUN=0
if [[ ${1:-} == --dry-run ]]; then DRY_RUN=1; shift; fi

REPO_SLUG=sunmachine/ntre-wiki
REPO_SLUG=NeotokyoRebuild/ntre-wiki
BRANCH=gh-pages
export NTRE_WIKI_URL=${NTRE_WIKI_URL:-https://sunmachine.github.io/ntre-wiki/}
export NTRE_WIKI_URL=${NTRE_WIKI_URL:-https://neotokyorebuild.github.io/ntre-wiki/}
export NO_MKDOCS_2_WARNING=1

say() { printf '\033[1m==> %s\033[0m\n' "$*"; }
Expand All @@ -37,7 +37,7 @@ die() { printf '\033[31merror:\033[0m %s\n' "$*" >&2; exit 1; }
[[ -x wiki/.venv/bin/mike ]] || die "no Python environment yet: run ./setup"
export PATH="$PWD/wiki/.venv/bin:$PATH"

# The remote for sunmachine/ntre-wiki, found by URL: origin in CI, often upstream locally.
# The remote for NeotokyoRebuild/ntre-wiki, found by URL: origin in CI, often upstream locally.
find_remote() {
REMOTE=
for r in $(git remote); do
Expand Down
2 changes: 1 addition & 1 deletion wiki/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ repo_url: https://github.com/NeotokyoRebuild/neo
repo_name: NeotokyoRebuild/neo
# "Edit this page" opens the page's Markdown in GitHub's editor, in this
# repository. It's a full address because repo_url points elsewhere.
edit_uri: https://github.com/sunmachine/ntre-wiki/edit/main/wiki/docs/
edit_uri: https://github.com/NeotokyoRebuild/ntre-wiki/edit/main/wiki/docs/

theme:
name: material
Expand Down
Loading