Skip to content

fix: register the Semgrep to Opengrep release note in the nav - #2746

Merged
claudiacodacy merged 1 commit into
masterfrom
fix/register-semgrep-migration-release-note
Sep 9, 2026
Merged

fix: register the Semgrep to Opengrep release note in the nav#2746
claudiacodacy merged 1 commit into
masterfrom
fix/register-semgrep-migration-release-note

Conversation

@claudiacodacy

Copy link
Copy Markdown
Contributor

docs/release-notes/cloud/cloud-2026-02-migrating-semgrep.md has been on disk since #2586 (Feb 2026) but has never appeared in mkdocs.yml. That PR added the file and the link on the release notes index, and missed the nav: entry.

Confirmed with git log -S cloud-2026-02-migrating-semgrep -- mkdocs.yml: no history.

Effect before this change

  • Page built and reachable at /release-notes/cloud/cloud-2026-02-migrating-semgrep/
  • Present in the RSS feed
  • Linked from the release notes index, so browsable from there
  • Absent from every sidebar — the one place readers scan release notes chronologically

Nothing caught it. MkDocs reports unregistered pages at info level, so mkdocs build --strict passed. It is the only orphaned page in the repo; the same info line lists no others.

Change

One line, placed per the convention in that block — the month note first, then that month's individual notes.

Checks

  • mkdocs build --strict passes with no warnings, and no longer reports an unregistered page
  • The note now renders in the Cloud 2026 sidebar, verified in the built HTML

cloud-2026-02-migrating-semgrep.md has been on disk and linked from the
release notes index since #2586, but was never added to mkdocs.yml. It
built, had a URL, and appeared in no sidebar. MkDocs reports unregistered
pages at info level, so the strict build passed.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@codacy-production

Copy link
Copy Markdown
Contributor

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@claudiacodacy
claudiacodacy marked this pull request as ready for review September 9, 2026 11:44
@claudiacodacy
claudiacodacy requested a review from a team as a code owner September 9, 2026 11:44
@github-actions
github-actions Bot temporarily deployed to Netlify September 9, 2026 11:44 Inactive

@codacy-production codacy-production 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.

Pull Request Overview

No merge-blocking issues were identified. Codacy reports the PR is up to standards, with no new issues or coverage findings.

The change should be validated with a strict MkDocs build and a rendered-sidebar check to confirm the page is registered and visible in the expected position.

About this PR

  • Add or run automated validation covering mkdocs build --strict and confirmation that the release note appears in the generated Cloud 2026 sidebar.

Test suggestions

  • Verify the Semgrep migration release note is listed in the Cloud 2026 navigation in the expected chronological position.
  • Run mkdocs build --strict and verify there are no unregistered-page warnings.
  • Inspect built HTML to verify the release note appears in the Cloud 2026 sidebar.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Run `mkdocs build --strict` and verify there are no unregistered-page warnings.
2. Inspect built HTML to verify the release note appears in the Cloud 2026 sidebar.

TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback

@claudiacodacy
claudiacodacy enabled auto-merge (squash) September 9, 2026 11:45
@claudiacodacy
claudiacodacy merged commit 0178d79 into master Sep 9, 2026
5 checks passed
@claudiacodacy
claudiacodacy deleted the fix/register-semgrep-migration-release-note branch September 9, 2026 11:46
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.

2 participants