Add reusable release-notes preview workflow - #1421
Conversation
PR SummaryThis PR introduces a new GitHub Actions workflow designed for previewing release notes. The workflow is triggered via both workflow_call and repository_dispatch events and accepts inputs such as a commit SHA, branch reference, PR number, and correlation ID. It performs several validations by comparing the provided inputs against the actual release-notes PR details retrieved via the GitHub API. For example, it checks that the commit SHA is valid, that the branch reference uses an approved prefix (either automated/* or codex/*), and that the PR number corresponds to an open PR from the expected repository. After successful validation, the workflow proceeds to:
Additionally, the PR removes a hardcoded branch reference from another workflow file, improving maintainability and ensuring that the docs site is validated against the current main branch of release notes. Test Suggestions
|
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
Lighthouse check results✓ INFO: No site pages to audit in this PR. Commit SHA: 1e4ef61 |
What and why?
Adds a documentation-owned release-notes preview workflow that can be invoked with an immutable
validmind/release-notescommit. It validates the source PR, performs the targeted Quarto render, and deploys to a stable per-PR preview URL.This replaces the temporary
ref:edit and paired documentation preview PR lifecycle. A follow-up release-notes PR will dispatch this workflow and surface its result on the release-notes PR.How to test
documentation:main, then tested against an open release-notes PR.What needs special review?
pr_previews/release-notes/pr-{number}.Dependencies, breaking changes, and deployment notes
Merge this PR before enabling the caller workflow in
validmind/release-notes. No production deployment behavior changes.Release notes
N/A — internal CI workflow change.
Checklist