diff --git a/.github/desired-repo-settings.json b/.github/desired-repo-settings.json index 120edc3..b506f4d 100644 --- a/.github/desired-repo-settings.json +++ b/.github/desired-repo-settings.json @@ -6,7 +6,8 @@ "dependabot_security_updates": "enabled" }, "pages": { - "build_type": "workflow" + "build_type": "workflow", + "cname": "phaser.boringstack.xyz" }, "actions": { "can_approve_pull_request_reviews": true diff --git a/BUILD_THE_GAME.md b/BUILD_THE_GAME.md index 2ab341a..09dd6b3 100644 --- a/BUILD_THE_GAME.md +++ b/BUILD_THE_GAME.md @@ -102,7 +102,7 @@ There are three GitHub settings the template can't flip for you, because the def | Setting | Path | Why | | --- | --- | --- | -| **Pages** | Settings → Pages → Build and deployment → Source: **"GitHub Actions"** | The `deploy-pages` workflow 404s without this; the workflow can't enable Pages itself without a broader token. | +| **Pages** | Settings → Pages → Build and deployment → Source: **"GitHub Actions"** | The `deploy-pages` workflow 404s without this; the workflow can't enable Pages itself without a broader token. The org demo uses the custom domain `phaser.boringstack.xyz` — do **not** copy that CNAME onto a fork. | | **Actions may open PRs** | Settings → Actions → General → Workflow permissions → **[x] Allow GitHub Actions to create and approve pull requests** | So `release-please` can cut release PRs from conventional commits. | | **Template repository** | Settings → General → **[x] Template repository** | So *your* forkers see the "Use this template" button. | @@ -117,6 +117,17 @@ gh api -X PUT /repos///actions/permissions/workflow \ -f default_workflow_permissions=write -F can_approve_pull_request_reviews=true ``` +The **org** demo is [phaser.boringstack.xyz](https://phaser.boringstack.xyz/). Chrome flags `boringstack-xyz.github.io` as a lookalike of `boringstack.xyz`, so the Pages site uses a real `boringstack.xyz` subdomain. Cloudflare DNS (DNS-only, not proxied): + +``` +Type CNAME +Name phaser +Target boringstack-xyz.github.io +Proxy DNS only +``` + +Then in the repo: Settings → Pages → Custom domain `phaser.boringstack.xyz` → Enforce HTTPS once the certificate exists. + ### Step 4 — Understand the demo slice The forked repo ships with a tiny vertical slice: diff --git a/README.md b/README.md index 0454f49..c76ba7d 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@

boringstack.xyz GitHub - Play the demo + Play the demo

@@ -41,7 +41,7 @@ Backend engineer, tech lead, web developer who always wanted to make games? Star ### After forking: one-time repo setup -1. **Enable GitHub Pages** — `Settings → Pages → Build and deployment → Source: "GitHub Actions"`. Without this the `deploy-pages` workflow 404s on the first run. +1. **Enable GitHub Pages** — `Settings → Pages → Build and deployment → Source: "GitHub Actions"`. Without this the `deploy-pages` workflow 404s on the first run. The org demo is served at [phaser.boringstack.xyz](https://phaser.boringstack.xyz/) (Chrome treats `boringstack-xyz.github.io` as a lookalike of `boringstack.xyz`). Forks keep the default `https://.github.io//` URL. 2. **Allow Actions to open PRs** (so release-please can cut release PRs) — `Settings → Actions → General → Workflow permissions → [x] Allow GitHub Actions to create and approve pull requests`. 3. **Flip "Template repository"** — `Settings → General → Template repository` so your own "Use this template" button works. diff --git a/docs/learn/05-solo-dev-workflow.md b/docs/learn/05-solo-dev-workflow.md index d6e0462..fabd1a6 100644 --- a/docs/learn/05-solo-dev-workflow.md +++ b/docs/learn/05-solo-dev-workflow.md @@ -105,7 +105,7 @@ For a 20-minute feature, skip the pipeline. For a 2-day feature, always run it. ### GitHub Pages (this template) - Free, one-click - Perfect for prototypes, devlogs, and portfolio pieces -- URL format `https://.github.io//` is fine for sharing +- URL format `https://.github.io//` is fine for sharing on a fork. The org demo is [phaser.boringstack.xyz](https://phaser.boringstack.xyz/) so Chrome does not treat `boringstack-xyz.github.io` as a lookalike of `boringstack.xyz`. ### Your own domain - Worth it once you have a name / brand