docs(skills): document pr-reference generate and filter flags in REFERENCE.md - #2776
Open
Mohammed Alkindi (MohammedAlkindi) wants to merge 2 commits into
Conversation
…RENCE.md REFERENCE.md's usage scenarios covered only --base-branch, --no-md-diff and --output, and the list-changed-files table omitted --exclude-type. The scripts and SKILL.md both support more than that. Adds usage scenarios for --merge-base/-MergeBase, --exclude-ext/-ExcludeExt with --exclude-path/-ExcludePath, and 'auto' base-branch detection, and adds the missing --exclude-type/-ExcludeType row with its mutual-exclusivity constraint against a non-'all' --type. Refreshes ms.date.
Mohammed Alkindi (MohammedAlkindi)
requested a review
from a team
as a code owner
August 24, 2026 21:29
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2776 +/- ##
==========================================
- Coverage 82.98% 82.95% -0.04%
==========================================
Files 183 171 -12
Lines 33787 33649 -138
Branches 25 0 -25
==========================================
- Hits 28038 27913 -125
+ Misses 5746 5736 -10
+ Partials 3 0 -3
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
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.
Description
references/REFERENCE.mddocuments three of the six flagsgenerate.shandgenerate.ps1accept.SKILL.mdalready lists all six, so the reference file is the one out of step.Adds usage scenarios for
--merge-base/-MergeBase,--exclude-extwith--exclude-path, andautobase-branch detection, following the existing scenario format. Adds the missing--exclude-type/-ExcludeTyperow to thelist-changed-filestable with its mutual-exclusivity constraint, and notes that--typeaccepts comma-separated values. Refreshesms.date.Related Issue(s)
Closes #2771
Type of Change
Code & Documentation:
Testing
Each statement was checked against the scripts rather than against
SKILL.md:--merge-base,--exclude-ext,--exclude-pathandauto: thecasearms ingenerate.shand thegenerate.ps1param block.ext="${ext#.}"andp="${p%/}"ingenerate.sh,TrimStart('.')andTrimEnd('/')inshared.psm1.autofalling back toorigin/main:resolve_default_branchingenerate.shandResolve-DefaultBranchinshared.psm1.list-changed-files.shexits with--type and --exclude-type are mutually exclusive when --type is not 'all'.npx cspellon the changed file reports 0 issues, andmarkdown-table-formattermakes no further change to the reformatted table.What I could not run, so CI is the authority on it:
validate:local,lint:tables,lint:frontmatterandlint:md-linksall shell out topwsh, and only Windows PowerShell 5.1 is available on this machine.lint:mdwould not have covered this file in any case, since.markdownlint-cli2.jsoncignores.github/skills/**.Checklist
Required Checks
Required Local Checks
npm run spell-check(run asnpx cspellagainst the changed file)Left unchecked deliberately:
npm run validate:localandnpm run lint:md-links, per the note above.Security Considerations
Additional Notes
Drafted with AI assistance. I read
generate.sh,generate.ps1,list-changed-files.shandshared.psm1myself and matched every flag I documented to the branch that parses it; the mutual-exclusivity sentence is taken from that script's own error string.