Skip to content

Commit Help Center snapshots only after a successful deploy - #1

Merged
Adron merged 1 commit into
mainfrom
fix/help-publish-order
Oct 23, 2026
Merged

Adron merged 1 commit into
mainfrom
fix/help-publish-order

Conversation

@Adron

@Adron Adron commented Oct 23, 2026

Copy link
Copy Markdown
Member

What

  • help.yml: the version snapshot is committed to help-versions only after deploy-pages succeeds. Before this change, it was committed first, so a failed deploy still used up a version number in the archive. Pages is currently unavailable for this repo, so that would have happened on the first run.
  • docs/PREREQUISITES.md: records the repo's real state after the first push:
    • the repo exists and is private
    • Actions jobs aren't started because of the org's billing ("recent account payments have failed or your spending limit needs to be increased")
    • GitHub Pages isn't available for this private repo on the current plan (422)

Verification

CI can't run until the Actions billing is fixed, so I checked locally:

  • All three workflow files parse; the help.yml step order is now build → configure-pages → upload → deploy → commit snapshot.
  • swift test in Packages/SubstratalKit: 15 tests pass.
  • help-generate + jekyll build + help-check: 75 screen pages, 115 internal links, none broken.

🤖 Generated with Claude Code

…epo, 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 <noreply@anthropic.com>

@Adron Adron left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed.

  • help.yml: steps are now build → configure-pages → upload → deploy → commit snapshot. A failed deploy ends the job before the archive commit, so no version number is used up. The live site still carries the new snapshot, because help-build.rb copies it into _site/versions/ before deploying.
  • Edge case: if deploy succeeds and the snapshot push then fails, the next run reuses that version number and replaces it on the live site. Acceptable: the help-pages concurrency group runs releases one at a time, so there's no race.
  • PREREQUISITES.md matches what GitHub returned: the repo is private, Actions billing errors, and Pages returns 422 on this plan.
  • Local checks pass (workflow YAML, 15 tests, Help Center build + link check). CI can't start until billing is fixed.

@Adron
Adron merged commit d8307eb into main Oct 23, 2026
0 of 3 checks passed
@Adron
Adron deleted the fix/help-publish-order branch October 23, 2026 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant