From b6676a3d9eb2fc5fb5069a6b47cab70cf544d44e Mon Sep 17 00:00:00 2001 From: Adron Hall Date: Fri, 23 Oct 2026 11:40:49 -0700 Subject: [PATCH] Commit Help Center snapshots only after a successful deploy; record repo, Actions and Pages status help.yml committed the version snapshot to help-versions before deploying, so a failed deploy (Pages unavailable, an outage) still used up a version number. The snapshot is now committed after deploy-pages succeeds. PREREQUISITES.md: the repo now exists (private); Actions jobs aren't started because of the org's billing; Pages isn't available for this private repo on the current plan. Co-Authored-By: Claude Opus 5.5 --- .github/workflows/help.yml | 20 +++++++++++--------- docs/PREREQUISITES.md | 5 +++-- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/.github/workflows/help.yml b/.github/workflows/help.yml index 52ac8d0..a3aa779 100644 --- a/.github/workflows/help.yml +++ b/.github/workflows/help.yml @@ -95,6 +95,17 @@ jobs: --commit "$GITHUB_SHA" \ --summary "$(git log -1 --format=%s)" + - uses: actions/configure-pages@v6 + + - uses: actions/upload-pages-artifact@v5 + with: + path: _site + + - id: deploy + uses: actions/deploy-pages@v5 + + # Only after a successful deploy: a failed deploy (Pages off, an outage) + # must not use up a version number in the archive. - name: Commit snapshot to help-versions working-directory: _archive env: @@ -116,12 +127,3 @@ jobs: git add -A git commit -m "Archive help v$VERSION from ${GITHUB_SHA::7}" git push origin help-versions - - - uses: actions/configure-pages@v6 - - - uses: actions/upload-pages-artifact@v5 - with: - path: _site - - - id: deploy - uses: actions/deploy-pages@v5 diff --git a/docs/PREREQUISITES.md b/docs/PREREQUISITES.md index acbb3ad..37f16b6 100644 --- a/docs/PREREQUISITES.md +++ b/docs/PREREQUISITES.md @@ -51,8 +51,9 @@ In this app: the base URL is the host root (`APIEnvironment.baseURL`). `APIVersi | Item | Status | Detail | |---|---|---| -| This repo's GitHub remote | ❌ **needs you** | `CompositeCode/substratalapps-macos` doesn't exist and the local repo has no remote or commits. Creating it and pushing is the one step left before CI and the Help Center go live. | -| GitHub Pages for the Help Center | ❌ | Enable after the first push: Settings → Pages → Source: **GitHub Actions**. The site publishes at `https://compositecode.github.io/substratalapps-macos/`, the address the app's Help menu uses (`SubstratalHelpBaseURL` in `project.yml`). | +| This repo's GitHub remote | ✅ | [`CompositeCode/substratalapps-macos`](https://github.com/CompositeCode/substratalapps-macos), **private**, created 2026-10-23; `main` pushed. | +| GitHub Actions | ❌ **billing** | The first runs (2026-10-23) weren't started: "recent account payments have failed or your spending limit needs to be increased". Fix under the CompositeCode org's **Settings → Billing & plans**. Until then CI doesn't run; run `make check` locally. macOS runners use the most minutes, so set a spending limit that covers them. | +| GitHub Pages for the Help Center | ❌ **plan** | GitHub refuses Pages on this private repo with the org's current plan (`422`). Either make the repo public (like `substratalapps.com`), or move to a plan with private Pages. Then set **Settings → Pages → Source: GitHub Actions** and run the Help Center workflow. The app's Help menu already points at `https://compositecode.github.io/substratalapps-macos/` (`SubstratalHelpBaseURL` in `project.yml`); if the site ends up somewhere else, change it there. | | API repo `openapi.yaml` (raw, `main`) | ✅ | `200`. `scripts/sync-openapi.sh` vendors it; a scheduled workflow keeps it current. | | Specs repo | ✅ | Up to date (`cebf679`, targets API v1.8.0). `scripts/import-screens.rb` imports its 75 macOS screens. |