Update PSSA for v1.25 release#382
Conversation
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 9e100e4:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentParametersKind.md | View (ps-modules) | Details | |
| reference/docs-conceptual/PSScriptAnalyzer/overview.md | ✅Succeeded | View (ps-modules) | |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AlignAssignmentStatement.md | ✅Succeeded | View (ps-modules) | |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidLongLines.md | ✅Succeeded | View (ps-modules) | |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md | ✅Succeeded | View (ps-modules) | |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentParameterSetName.md | ✅Succeeded | View (ps-modules) | |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConstrainedLanguageMode.md | ✅Succeeded | View (ps-modules) | |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingleValueFromPipelineParameter.md | ✅Succeeded | View (ps-modules) | |
| reference/docs-conceptual/toc.yml | ✅Succeeded | View (ps-modules) |
reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentParametersKind.md
- Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 6, Column 1: [Warning: h1-not-first - See documentation]
Markdown content is not allowed before H1 'UseConsistentParametersKind'. - Line 1, Column 1: [Suggestion: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
sdwheeler
changed the title
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 7381f00:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentParametersKind.md | View (ps-modules) | Details | |
| reference/docs-conceptual/PSScriptAnalyzer/overview.md | ✅Succeeded | View (ps-modules) | |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AlignAssignmentStatement.md | ✅Succeeded | View (ps-modules) | |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidLongLines.md | ✅Succeeded | View (ps-modules) | |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md | ✅Succeeded | View (ps-modules) | |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentParameterSetName.md | ✅Succeeded | View (ps-modules) | |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConstrainedLanguageMode.md | ✅Succeeded | View (ps-modules) | |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingleValueFromPipelineParameter.md | ✅Succeeded | View (ps-modules) | |
| reference/docs-conceptual/toc.yml | ✅Succeeded | View (ps-modules) |
reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentParametersKind.md
- Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 6, Column 1: [Warning: h1-not-first - See documentation]
Markdown content is not allowed before H1 'UseConsistentParametersKind'. - Line 1, Column 1: [Suggestion: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
There was a problem hiding this comment.
Pull request overview
Updates the PSScriptAnalyzer conceptual docs set for the v1.25 release, including refreshed install guidance and expanded/added rule reference content.
Changes:
- Bump the TOC entry from PSScriptAnalyzer v1.24 to v1.25.
- Update the PSScriptAnalyzer overview (ms.date + installation instructions order/commands).
- Add new rule reference pages and update existing rule docs + rules index.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| reference/docs-conceptual/toc.yml | Updates PSScriptAnalyzer section label to v1.25 (and should also carry rule-nav updates). |
| reference/docs-conceptual/PSScriptAnalyzer/overview.md | Updates ms.date and installation instructions for PSResourceGet/PowerShellGet. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingleValueFromPipelineParameter.md | Adds new rule reference documentation page. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConstrainedLanguageMode.md | Adds new rule reference documentation page. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentParametersKind.md | Adds new rule reference doc (currently has malformed front matter). |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentParameterSetName.md | Adds new rule reference documentation page. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md | Updates rule index table to include newly added rules. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidLongLines.md | Updates ms.date and improves wording/line wrapping. |
| reference/docs-conceptual/PSScriptAnalyzer/Rules/AlignAssignmentStatement.md | Updates ms.date and expands/modernizes rule documentation + config options. |
Comments suppressed due to low confidence (1)
reference/docs-conceptual/toc.yml:55
- The PSScriptAnalyzer "Rules reference" TOC list doesn't include the newly added rule pages (UseConsistentParameterSetName, UseConsistentParametersKind, UseConstrainedLanguageMode, UseSingleValueFromPipelineParameter), so these pages won't appear in the left-nav. Add entries for these rules under
- name: Rules referencein the appropriate alphabetical position.
- name: PSScriptAnalyzer v1.25
items:
- name: Overview
href: PSScriptAnalyzer/overview.md
- name: What's new in PSScriptAnalyzer
href: PSScriptAnalyzer/whats-new-in-pssa.md
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| description: Use the same pattern when defining parameters. | ||
| ms.date: 03/20/2026 | ||
| ms.topic: reference | ||
| title: UseConsistentParametersKind | ||
| --- | ||
| # UseConsistentParametersKind |
There was a problem hiding this comment.
This page's YAML front matter is malformed: it has the closing --- but is missing the opening --- at the top of the file. This prevents metadata (title/ms.date/ms.topic) from being parsed correctly by the docs build; add the opening delimiter above description:.
| When the rule sets parameters definition kind to `ParamBlock`: | ||
|
|
||
| ```powershell | ||
| # Inorrect |
There was a problem hiding this comment.
Typo in the example comment: "Inorrect" should be "Incorrect".
| # Inorrect | |
| # Incorrect |
PR Summary
Update PSSA cor v1.25 release
PR Checklist