Skip to content

Commit Help Center snapshots only after a successful deploy #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Adron merged 1 commit into from
Oct 23, 2026
Merged

Commit Help Center snapshots only after a successful deploy #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 11 additions & 9 deletions .github/workflows/help.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
5 changes: 3 additions & 2 deletions docs/PREREQUISITES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

Expand Down
Loading