Skip to content

Render release-note planning previews - #1426

Merged
cachafla merged 1 commit into
mainfrom
codex/release-notes-previews
Jul 23, 2026
Merged

Render release-note planning previews#1426
cachafla merged 1 commit into
mainfrom
codex/release-notes-previews

Conversation

@cachafla

Copy link
Copy Markdown
Contributor

What changed

  • include previews/** when checking out release-notes PR revisions
  • select previews/<version> as a targeted render directory alongside versioned releases/**
  • populate preview sources into the documentation tree before rendering

Why

Release planning previews are intentionally stored outside releases/** so they cannot enter normal release publication. The release-notes PR preview workflow needs a receiver that can render this isolated source path into its PR-specific staging prefix.

This PR must merge before validmind/release-notes#123 is marked ready for review.

Validation

  • workflow YAML parses successfully
  • preview target selector resolves previews/26.08 and existing release targets correctly
  • existing test_merge_quarto_indexes.py suite: 3 passed
  • simulated receiver population and quarto render --profile development previews/26.08
  • rendered _site/previews/26.08/release-notes.html with no warnings or errors

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

Copy link
Copy Markdown
Contributor

PR Summary

This PR extends the GitHub Actions workflow for generating release notes by adding support for preview directories. The main changes are:

  • Addition of the 'previews' directory to the sparse-checkout configuration, enabling the workflow to include both release and preview content.
  • Modification of the diff command that selects changed directories to handle both 'releases' and 'previews'. Specifically, the AWK script now:
    • Processes paths under the 'releases' directory with at least 4 components.
    • Processes paths under the 'previews' directory with at least 3 components.
  • Updates to log messages to reflect the inclusion of preview directories in the process.
  • Inclusion of conditional logic to copy the preview directory from the source if it exists, ensuring that preview release notes are generated alongside regular releases.

Test Suggestions

  • Test with changes only in the 'releases' directory to ensure that the workflow behaves as expected.
  • Test with changes only in the 'previews' directory to validate that the workflow detects and processes preview directories correctly.
  • Test with changes in both directories to confirm that both sets of changes are handled and logged.
  • Verify that the output file (.release-preview-targets) correctly lists directories from both 'releases' and 'previews' and that the log messages accurately reflect these changes.
  • Test the conditional copying of the 'previews' directory when it exists and confirm that the file structure is maintained in the target directory.

@cachafla
cachafla marked this pull request as ready for review July 23, 2026 01:04
@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

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

@github-actions

Copy link
Copy Markdown
Contributor

Lighthouse check results

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

Commit SHA: e1afebe

@cachafla
cachafla merged commit f55abbe into main Jul 23, 2026
11 checks passed
@cachafla
cachafla deleted the codex/release-notes-previews branch July 23, 2026 01:54
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