Skip to content

docs: correct analyzer-promotion, release trigger, and TPS003 references - #31

Merged
Alpaq92 merged 1 commit into
masterfrom
docs-2.5.1
Aug 4, 2026
Merged

docs: correct analyzer-promotion, release trigger, and TPS003 references#31
Alpaq92 merged 1 commit into
masterfrom
docs-2.5.1

Conversation

@Alpaq92

@Alpaq92 Alpaq92 commented Aug 4, 2026

Copy link
Copy Markdown
Owner

Doc-set corrections found while cutting 2.5.1. Three claims did not match the repo.

1. Analyzer promotion is manual, not automatic

README (the CI-matrix release.yml row and the Maintainer notes bullet) and the AnalyzerReleases.Unshipped.md runbook all state that release.yml auto-promotes analyzer rules into Shipped.md via a Promote analyzer rules to Shipped step.

No such step exists. release.yml has no promotion logic anywhere, and neither does any script — grep -rn Unshipped across the repo hits only the workflow's own header comment and the analyzer .csproj's AdditionalFiles line. release.yml's header comment describes promotion as "a deliberate maintainer commit, ideally folded into the release PR before it merges", which is what actually happens. Shipped.md is empty while TPS001–TPS003 have shipped in released NuGets straight from Unshipped.md — which is fine, and the docs now say so.

The runbook's RS2007 claim is corrected too: RS2007 fires for an implemented rule listed in neither file, not for one that sits unshipped. The runbook also now says to promote under the version that first shipped each rule, rather than sweeping all three under whatever release happens to be cutting.

2. release.yml trigger

The CI-matrix row listed it as scheduled; it is push to master plus workflow_dispatch, and only the release PR merging reaches the pack-and-publish job.

3. TPS003

Shipped in 2.4.0, but README (repo layout, FAQ 12) and CONTRIBUTING still listed the analyzer as TPS001/TPS002 only.

Also

Adds a Maintainer notes bullet for the codeql-action init/analyze SHA-pair invariant and the dependabot group that now enforces it — see #25 / #28.


Docs-only; no code or workflow behaviour changes. The AnalyzerReleases.Unshipped.md edit touches only ; comment lines, leaving the ### New Rules table byte-identical, so the analyzer's release-tracking input is unchanged.

Three claims in the doc set did not match the repo:

- README (CI-matrix row and maintainer notes) and the
  AnalyzerReleases.Unshipped.md runbook all state that release.yml
  auto-promotes analyzer rules into Shipped.md via a "Promote analyzer
  rules to Shipped" step. No such step exists — release.yml's own header
  comment describes promotion as a manual maintainer commit, and that is
  what actually happens. Shipped.md is empty while TPS001-TPS003 have
  shipped in released NuGets from Unshipped.md, which is fine: rules are
  valid there indefinitely. The runbook's RS2007 claim is corrected too —
  RS2007 fires for an implemented rule that is listed in neither file,
  not for one that sits unshipped. Also notes that promotion should use
  the version that first shipped each rule rather than sweeping all three
  under whatever release is being cut.

- The CI-matrix row listed release.yml's trigger as "scheduled"; it is
  `push` to master (plus workflow_dispatch), and only the release PR
  merging reaches the pack-and-publish job.

- TPS003 shipped in 2.4.0 but README (repo layout, FAQ 12) and
  CONTRIBUTING still listed the analyzer as TPS001/TPS002 only.

Adds a maintainer note for the codeql-action init/analyze SHA-pair
invariant and the dependabot group that now enforces it.

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

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@Alpaq92, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 22 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 4f563f1f-8349-4f4f-aed9-c80abe207921

📥 Commits

Reviewing files that changed from the base of the PR and between c461990 and 7b8cdeb.

📒 Files selected for processing (3)
  • CONTRIBUTING.md
  • README.md
  • TopSecret.ProtectedString.Analyzers/AnalyzerReleases.Unshipped.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@Alpaq92
Alpaq92 enabled auto-merge (squash) August 4, 2026 08:32
@Alpaq92
Alpaq92 disabled auto-merge August 4, 2026 08:35
@Alpaq92
Alpaq92 merged commit 8e06c60 into master Aug 4, 2026
7 checks passed
@Alpaq92
Alpaq92 deleted the docs-2.5.1 branch August 4, 2026 08:35
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