Skip to content

docs(security): document PSGallery module staleness check - #3219

Open
Mohammed Alkindi (MohammedAlkindi) wants to merge 3 commits into
microsoft:mainfrom
MohammedAlkindi:docs/security-document-psgallery-staleness
Open

Mohammed Alkindi (MohammedAlkindi) wants to merge 3 commits into
microsoft:mainfrom
MohammedAlkindi:docs/security-document-psgallery-staleness

Conversation

@MohammedAlkindi

Copy link
Copy Markdown
Contributor

Pull Request

Description

Test-SHAStaleness.ps1 also checks the psModules pins in tool-checksums.json against the PowerShell Gallery through Get-PSModuleStaleness, but the security README only describes the action check. This adds the module check and the HVE_PSGALLERY_REPOSITORY override to its Features list, and adds Get-PSGalleryApiBase to the SecurityHelpers function table.

Related Issue(s)

Fixes #1434

Type of Change

  • Documentation update

Sample Prompts (for AI Artifact Contributions)

N/A

Testing

markdownlint-cli2, cspell and Validate-MarkdownFrontmatter.ps1 pass on the changed file.

Checklist

Required Checks

  • Documentation is updated (if applicable)
  • Files follow existing naming conventions
  • Changes are backwards compatible (if applicable)
  • Tests added for new functionality (if applicable)

AI Artifact Contributions

N/A

Required Local Checks

  • Local validation aggregate: npm run validate:local
  • Documentation validation (if docs changed): npm run validate:docs
  • Spell checking: npm run spell-check
  • Link validation: npm run lint:md-links

Security Considerations

  • This PR does not contain any sensitive or NDA information
  • Any new dependencies have been reviewed for security issues
  • Security-related scripts follow the principle of least privilege

Additional Notes

None.

Describe the psModules check in Test-SHAStaleness.ps1 and the HVE_PSGALLERY_REPOSITORY override, and list Get-PSGalleryApiBase in the SecurityHelpers function table.

Closes microsoft#1434
@codecov-commenter

Codecov Comments Bot (codecov-commenter) commented Oct 13, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.74%. Comparing base (d540a54) to head (21b42bd).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #3219      +/-   ##
==========================================
- Coverage   81.90%   81.74%   -0.17%     
==========================================
  Files         125      109      -16     
  Lines       17625    17317     -308     
  Branches       63        0      -63     
==========================================
- Hits        14436    14156     -280     
+ Misses       3178     3161      -17     
+ Partials       11        0      -11     
Flag Coverage Δ
docusaurus ?
pester 86.32% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 17 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.

Comment thread scripts/security/README.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: can you also update the ms.date to go along?

auto-merge was automatically disabled October 13, 2026 16:32

Head branch was pushed to by a user without write access

@bindsi Marcel Bindseil (bindsi) left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Mohammed Alkindi (@MohammedAlkindi), thank you for this contribution and for all the fixes you've been sending lately. They're much appreciated! Before we continue with the review, could you please take care of a few process items:

1. Complete all required checks

The Required Local Checks in the description are still unchecked. Please run these locally, fix anything they report, and tick each box once it passes (or mark it N/A with a short reason):

  • npm run validate:local
  • npm run validate:docs (if docs changed)
  • npm run spell-check
  • npm run lint:md-links

2. Issue link

Thanks for linking #1434 with a closing keyword. That part is all set, so please keep it in the regenerated description.

Thanks again! I'm happy to take another look as soon as these are in place.

This branch has not been deployed

No deployments
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 scripts/security/README.md for PSGallery staleness check

6 participants