Skip to content

docs(skills): document pr-reference generate and filter flags in REFERENCE.md - #2776

Open
Mohammed Alkindi (MohammedAlkindi) wants to merge 2 commits into
microsoft:mainfrom
MohammedAlkindi:docs/2771-pr-reference-usage-scenarios
Open

docs(skills): document pr-reference generate and filter flags in REFERENCE.md#2776
Mohammed Alkindi (MohammedAlkindi) wants to merge 2 commits into
microsoft:mainfrom
MohammedAlkindi:docs/2771-pr-reference-usage-scenarios

Conversation

@MohammedAlkindi

Copy link
Copy Markdown

Description

references/REFERENCE.md documents three of the six flags generate.sh and generate.ps1 accept. SKILL.md already lists all six, so the reference file is the one out of step.

Adds usage scenarios for --merge-base/-MergeBase, --exclude-ext with --exclude-path, and auto base-branch detection, following the existing scenario format. Adds the missing --exclude-type/-ExcludeType row to the list-changed-files table with its mutual-exclusivity constraint, and notes that --type accepts comma-separated values. Refreshes ms.date.

Related Issue(s)

Closes #2771

Type of Change

Code & Documentation:

  • Documentation update

Testing

Each statement was checked against the scripts rather than against SKILL.md:

  • --merge-base, --exclude-ext, --exclude-path and auto: the case arms in generate.sh and the generate.ps1 param block.
  • Leading dot and trailing slash stripping: ext="${ext#.}" and p="${p%/}" in generate.sh, TrimStart('.') and TrimEnd('/') in shared.psm1.
  • auto falling back to origin/main: resolve_default_branch in generate.sh and Resolve-DefaultBranch in shared.psm1.
  • Mutual exclusivity: list-changed-files.sh exits with --type and --exclude-type are mutually exclusive when --type is not 'all'.

npx cspell on the changed file reports 0 issues, and markdown-table-formatter makes no further change to the reformatted table.

What I could not run, so CI is the authority on it: validate:local, lint:tables, lint:frontmatter and lint:md-links all shell out to pwsh, and only Windows PowerShell 5.1 is available on this machine. lint:md would not have covered this file in any case, since .markdownlint-cli2.jsonc ignores .github/skills/**.

Checklist

Required Checks

  • Documentation is updated (if applicable)
  • Files follow existing naming conventions
  • Changes are backwards compatible (if applicable)

Required Local Checks

  • Spell checking: npm run spell-check (run as npx cspell against the changed file)

Left unchecked deliberately: npm run validate:local and npm run lint:md-links, per the note above.

Security Considerations

  • This PR does not contain any sensitive or NDA information
  • Any new dependencies have been reviewed for security issues (none added)

Additional Notes

Drafted with AI assistance. I read generate.sh, generate.ps1, list-changed-files.sh and shared.psm1 myself 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.

…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.
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.95%. Comparing base (3c3dc02) to head (7b0cef7).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            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     
Flag Coverage Δ
docusaurus ?
pester 83.45% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 14 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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.

docs: Update stale documentation - .github/skills/shared/pr-reference/references/REFERENCE.md

2 participants