Skip to content

Preview library release notes: v2.13.3#1387

Open
validbeck wants to merge 2 commits into
mainfrom
automated/preview-library-v2.13.3
Open

Preview library release notes: v2.13.3#1387
validbeck wants to merge 2 commits into
mainfrom
automated/preview-library-v2.13.3

Conversation

@validbeck

@validbeck validbeck commented Jul 8, 2026

Copy link
Copy Markdown
Collaborator

Pull Request Description

sc-17067

What and why?

Preview for Patch release notes: 2.13.3 (#94).

Warning

This PR automatically checks out the release notes branch automated/library-v2.13.3 in .github/workflows/validate-docs-site.yaml so the preview displays the in-progress release notes (temporary ref: — remove before merge).

Release type Feature release (minor/major)
Version 2.13.3
validate-docs-site.yaml (REVERT BEFORE MERGE) Temporary ref: automated/library-v2.13.3 on Check out release-notes repository step

How to regenerate release notes preview

After updates are pushed to the linked release-notes PR: https://github.com/validmind/release-notes/pull/94

  1. Open this PR in validmind/documentation
  2. Re-run Validate docs site workflow (Actions tab → Validate docs site ... in the left sidebar → Select the latest workflow run linked to this PR → Re-run all jobs)

No commits on this branch are required — that workflow already checks out release-notes branch automated/library-v2.13.3 via the temporary ref: on the Check out release-notes repository step.

How to test

Click on the live documentation previews.

Public release notes

Important

Release notes author to remove links to pages without updates before marking release-notes PR ready for review.

What needs special review?

Auto-generated. Complete What needs special review? on the linked release-notes PR — not here.

  1. Verify that you can see release notes in the previews above as expected and that they render without any issues.
  2. Work through the merge checklist below

Merge (documentation preview)

  • Verify that you can see release notes in the previews as expected and that they render without any issues
  • Only when you are satisfied with the release notes, merge the linked release-notes PR to main first
  • On this branch, resolve the automated CHANGES_REQUESTED review by removing the ref: line from .github/workflows/validate-docs-site.yaml (keep repository: and path:)
  • Confirm Validate docs site passes again on this PR
  • Merge this PR to documentation / main after the release-notes PR merges sucessfully

Dependencies, breaking changes, and deployment notes

Release-notes PR (complete review there): Library release notes: v2.13.3 (#94) — customer-facing .qmd content and full track checklist.

Release notes

n/a (internal label — customer-facing content is in validmind/release-notes)

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)

@validbeck validbeck added the internal Not to be externalized in the release notes label Jul 8, 2026
@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Lighthouse check results

✓ INFO: No site pages to audit in this PR.

Commit SHA: f996e7c

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Remove the ref: line from the Check out release-notes repository step in .github/workflows/validate-docs-site.yaml before merging — it must not land on main. CI on this PR validates the release-notes branch; after merge, main should check out release-notes default branch.

Comment thread .github/workflows/validate-docs-site.yaml
@validbeck validbeck dismissed github-actions[bot]’s stale review July 9, 2026 17:01

Retesting the changes requested comment

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.3

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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)

Suggested change
ref: automated/library-v2.13.3

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

PR Summary

This PR updates the GitHub Actions workflow used for validating the documentation site. The change specifically adds a new parameter in the checkout step for the release-notes repository, setting the ref to automated/library-v2.13.3. This allows the workflow to always use a consistent snapshot of the release-notes, ensuring that the documentation site is built against a known reference. The update improves reproducibility in the CI/CD pipeline for the documentation site.

Test Suggestions

  • Run the GitHub Actions workflow in a testing branch to verify that the checkout operation retrieves the correct commit from the release-notes repository.
  • Validate that the documentation site is generated correctly and reflects the expected release notes.
  • Check that the workflow fails gracefully if the specified ref does not exist.

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Lighthouse check results

✓ INFO: No site pages to audit in this PR.

Commit SHA: 3d87813

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant