Skip to content

Constrain release-notes doc links to existing files - #26

Merged
frontegg-david merged 1 commit into
release/2.6.xfrom
ci/release-notes-doc-links
Aug 12, 2026
Merged

Constrain release-notes doc links to existing files#26
frontegg-david merged 1 commit into
release/2.6.xfrom
ci/release-notes-doc-links

Conversation

@frontegg-david

Copy link
Copy Markdown
Contributor

The v2.6.1 release notes linked to docs/overlay.md, which does not exist (overlay docs live in docs/curation.md) — the AI notes generator constructed a plausible filename instead of a real one. The published release body has already been corrected in place.

This PR prevents the next occurrence: the notes-generation step now reads the actual docs/ directory listing at generation time, injects it into the prompt as the only valid link targets, and the link rule requires filenames copied verbatim from that list instead of "files that appear in the diff" (which the model cannot reliably verify).

Test plan

  • Workflow YAML validated after the edit
  • Prompt-only change to publish-release.yml; no library code touched

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f2257587-6ed0-4db0-8780-b27fa5ea0ab6

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Comment @coderabbitai help to get the list of available commands.

@frontegg-david
frontegg-david merged commit 0a2912a into release/2.6.x Aug 12, 2026
7 checks passed
@frontegg-david
frontegg-david deleted the ci/release-notes-doc-links branch August 12, 2026 13:45
@github-actions

Copy link
Copy Markdown
Contributor

Cherry-pick Created

A cherry-pick PR to main has been automatically created.

Please review and merge if this change should also be in main.

If the cherry-pick is not needed, close the PR.

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