fix(review): generated contributor docs no longer overclaim requireLinkedIssue enforcement#5300
Merged
Merged
Conversation
…nkedIssue enforcement requireLinkedIssue alone only surfaces the missing_linked_issue advisory finding -- it never blocks a PR on its own (the real authority is linkedIssueGateMode === "block", default "advisory"). Generated docs (repo-skill-render.ts, repo-doc-render.ts) rendered "Required: yes" from requireLinkedIssue alone, so the common "toggle requireLinkedIssue, never touch the gate-mode dropdown" case produced docs claiming enforcement that wasn't actually happening. Threads linkedIssueGateMode through RepoProfileContributionWorkflow and keys the rendered text off it instead. Also corrects the overstating db/schema.ts comment and adds a doc comment to requireLinkedIssue itself. Refs #5287
Contributor
|
Superagent didn't find any vulnerabilities or security issues in this PR. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5300 +/- ##
=======================================
Coverage 94.36% 94.36%
=======================================
Files 474 474
Lines 40124 40124
Branches 14629 14629
=======================================
Hits 37865 37865
Misses 1583 1583
Partials 676 676
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
Closed
22 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
requireLinkedIssuealone only surfaces themissing_linked_issueadvisory finding — it never blocks a PR on its own. The real blocking authority islinkedIssueGateMode === "block"(default"advisory").repo-skill-render.ts,repo-doc-render.ts) rendered "Required: yes" fromrequireLinkedIssuealone, so a maintainer who toggles it on without separately settinglinkedIssueGateMode: "block"gets docs that overclaim enforcement.linkedIssueGateModethroughRepoProfileContributionWorkflowand keys the rendered text off it. Also corrects thedb/schema.tscomment that made the same overstatement, and adds a doc comment torequireLinkedIssueitself.Scope
src/types.ts,src/db/schema.ts,src/review/repo-profile.ts,src/review/repo-skill-render.ts,src/review/repo-doc-render.ts+ 4 test files updated for the new required field + 2 new regression tests.Validation
npm run typecheck— cleannpx vitest run test/unit/repo-skill-render.test.ts test/unit/repo-doc-render.test.ts test/unit/repo-profile.test.ts test/unit/generated-doc-refresh.test.ts— 92/92 passingnpm run docs:drift-check— cleanSafety
Deliberately did NOT widen the
focus-manifest.ts:626promotion condition (would be a real behavior change, its own decision) — this PR is doc-accuracy only.Closes #5287