Skip to content

docs: maintain API versions through release PRs - #363

Draft
crandmck wants to merge 1 commit into
mainfrom
rmckinne-adobe-release-docs-publishing
Draft

crandmck wants to merge 1 commit into
mainfrom
rmckinne-adobe-release-docs-publishing

Conversation

@crandmck

Copy link
Copy Markdown
Collaborator

Changes in this pull request

Move api-docs/versions.json maintenance into the release PR instead of having the documentation workflow commit and push directly to protected main.

  • Remove the automatic version-list update and Git commit/push step introduced by docs: update API doc versions on stable releases #357.
  • Keep repository contents access read-only and disable persisted checkout credentials; GitHub Pages deployment permissions are unchanged.
  • Publish docs on GitHub release publication or manual dispatch, not pushes to main. This avoids trying to build a newly merged version entry before its release exists; the builder remains strict about published releases.
  • Document adding entries for new stable major/minor lines in the release PR, retaining older entries and skipping patch releases and prereleases. Add a reminder to the PR checklist.
  • Documentation-only updates require manual dispatch after merging. This change does not alter the selected versions or automatically prepare release PRs.

Validation: all 10 existing versioned-documentation tests passed; YAML checks confirmed release/manual triggers, read-only contents permissions, disabled persisted credentials, and preserved build/deployment steps. git diff --check passed.

Checklist

  • This PR represents a single feature, fix, or change.
  • All applicable changes have been documented.
  • If this is a stable release introducing a new major/minor version line, its tag has been added to api-docs/versions.json (patch releases and prereleases do not add entries). N/A: this is not a release PR.
  • Any TO DO items (or similar) have been entered as GitHub issues and the link to that issue has been included in a comment. N/A: no TODO items added.

Remove automatic version-list commits and push-triggered deployment. Publish the reviewed list after release publication or manual dispatch.

Co-authored-by: Copilot App <[email protected]>
@crandmck
crandmck requested a review from ok-nick November 12, 2026 19:38
@crandmck
crandmck marked this pull request as draft November 12, 2026 19:41

This branch has not been deployed

No deployments
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