Preview library release notes: v2.13.4#1394
Conversation
There was a problem hiding this comment.
REMOVE ref: TO release-notes BRANCH
Important
Remove the ref: line from the Check out release-notes repository workflow step in .github/workflows/validate-docs-site.yaml before merging — the temporary ref: must not land on documentation:main.
| uses: actions/checkout@v4 | ||
| with: | ||
| repository: validmind/release-notes | ||
| ref: automated/library-v2.13.4 |
There was a problem hiding this comment.
Remove this ref: line to the working release-notes branch before merge. After the linked release-notes PR merges, workflow should check out release-notes:main. (view in .github/workflows/validate-docs-site.yaml)
| ref: automated/library-v2.13.4 |
PR SummaryThis pull request updates the GitHub Actions workflow for validating the docs site by explicitly setting the ref for the release-notes repository checkout. Instead of checking out the default branch, the workflow now uses the branch (or tag) 'automated/library-v2.13.4'. This change ensures that the docs site is built using a specific version of the release notes, thereby improving consistency and reliability of the generated documentation. 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: 85c57f5 |
Pull Request Description
What and why?
Preview for Patch release notes: 2.13.4 (#95).
Warning
This PR automatically checks out the release notes branch
automated/library-v2.13.4in.github/workflows/validate-docs-site.yamlso the preview displays the in-progress release notes (temporaryref:— remove before merge).2.13.4validate-docs-site.yaml(REVERT BEFORE MERGE)ref: automated/library-v2.13.4on Check out release-notes repository stepHow to regenerate release notes preview
After updates are pushed to the linked release-notes PR: https://github.com/validmind/release-notes/pull/95
validmind/documentationNo commits on this branch are required — that workflow already checks out release-notes branch
automated/library-v2.13.4via the temporaryref:on the Check out release-notes repository step.How to test
Click on the live
documentationpreviews.Public release notes
Important
Release notes author to remove links to pages without updates before marking
release-notesPR ready for review.What needs special review?
Auto-generated. Complete What needs special review? on the linked
release-notesPR — not here.Merge (documentation preview)
release-notesPR tomainfirstCHANGES_REQUESTEDreview by removing theref:line from.github/workflows/validate-docs-site.yaml(keeprepository:andpath:)documentation/mainafter therelease-notesPR merges sucessfullyDependencies, breaking changes, and deployment notes
Release-notes PR (complete review there): Library release notes: v2.13.4 (#95) — customer-facing
.qmdcontent and full track checklist.Release notes
n/a (
internallabel — customer-facing content is invalidmind/release-notes)Checklist