docs(deploy): describe new PAT-based dispatch credential#55
Merged
Conversation
Sibling sourcebans-pp dispatcher swapped from a GitHub App to a
fine-grained PAT (`secrets.DOCS_DEPLOY_PAT` + paired
`vars.DOCS_DEPLOY_ENABLED` feature flag). The deploy workflow in
THIS repo doesn't change behaviorally — it still listens for
`repository_dispatch` from anywhere; whatever credential the
dispatcher uses is invisible to us. But the comment block above
the workflow specifically mentions the App by name, which would
mislead anyone debugging the cutover after the sibling change
lands. Update the comment to describe the PAT-based setup
instead, and frame it as optional ("for automatic deploys on docs
PR merges; `workflow_dispatch` and the weekly cron cover the
bases otherwise") since this repo's `workflow_dispatch` button
remains the no-credentials manual fallback.
No code change; comments only.
Sibling sourcebans-pp dispatcher dropped the redundant feature-flag variable in favor of a step-level `if: secrets.DOCS_DEPLOY_PAT != ''` guard. Mirror the comment update so the optional-cutover paragraph in this workflow's header doesn't list a variable the operator no longer needs to set. Comment-only; no behavioral change.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Followup to #54 + sbpp/sourcebans-pp#1347 (issue sbpp/sourcebans-pp#1333 cutover).
What this PR changes
Comments only — no behavioral change to the deploy workflow.
The sibling sourcebans-pp dispatcher (
docs-deploy-trigger.yml) is being switched from a GitHub App to a fine-grained PAT in sbpp/sourcebans-pp#1347. The deploy workflow in this repo doesn't change — it still listens forrepository_dispatchevents withevent_type: docs-changedfrom anywhere, and whatever credential the dispatcher uses is invisible to us.But the comment block above this workflow specifically mentions the App by name (
sbpp-docs-deploy) and references the oldvars.DOCS_DEPLOY_APP_ID+secrets.DOCS_DEPLOY_APP_KEYpair on the sourcebans-pp side. That would mislead anyone debugging the cutover after the sibling PR lands. This PR updates the comment to describe the PAT-based setup (secrets.DOCS_DEPLOY_PATonly — no paired feature-flag variable) and reframes it as optional — theworkflow_dispatchbutton (manual) and weekly cron (safety net) on this repo cover the bases without any cross-repo credential at all.Diff
Pure comment churn.
python3 -c 'import yaml; yaml.safe_load(...)'still parses.Merge order
This can land any time — independent of sbpp/sourcebans-pp#1347. The two PRs document the same cutover from different sides; merging either before the other won't break anything.