refactor(scripts): refactor dev-tools and lib scripts to use CIHelpers module by chaosdinosaur · Pull Request #482 · microsoft/hve-core

chaosdinosaur · 2026-02-12T00:06:17Z

Pull Request

Description

Add CIHelpers module import, mocking, and cleanup to test files for Generate-PrReference.ps1 and Get-VerifiedDownload.ps1. Add error propagation tests verifying CI annotation handling paths.
Replace remaining inline $env:GITHUB_ACTIONS check and raw ::error:: output in Test-ActionVersionConsistency.ps1 catch block with Write-CIAnnotation.

Related Issue(s)

Fixes #352

Type of Change

Select all that apply:

Code & Documentation:

Bug fix (non-breaking change fixing an issue)
New feature (non-breaking change adding functionality)
Breaking change (fix or feature causing existing functionality to change)
Documentation update

Infrastructure & Configuration:

AI Artifacts:

Reviewed contribution with prompt-builder agent and addressed all feedback
Copilot instructions (.github/instructions/*.instructions.md)
Copilot prompt (.github/prompts/*.prompt.md)
Copilot agent (.github/agents/*.agent.md)
Copilot skill (.github/skills/*/SKILL.md)

Note for AI Artifact Contributors:

Agents: Research, indexing/referencing other project (using standard VS Code GitHub Copilot/MCP tools), planning, and general implementation agents likely already exist. Review .github/agents/ before creating new ones.

Skills: Must include both bash and PowerShell scripts. See Skills.

Model Versions: Only contributions targeting the latest Anthropic and OpenAI models will be accepted. Older model versions (e.g., GPT-3.5, Claude 3) will be rejected.

See Agents Not Accepted and Model Version Requirements.

Other:

Script/automation (.ps1, .sh, .py)
Other (please describe):

Sample Prompts (for AI Artifact Contributions)

User Request:

Execution Flow:

Output Artifacts:

Success Indicators:

For detailed contribution requirements, see:

Common Standards: docs/contributing/ai-artifacts-common.md - Shared standards for XML blocks, markdown quality, RFC 2119, validation, and testing
Agents: docs/contributing/custom-agents.md - Agent configurations with tools and behavior patterns
Prompts: docs/contributing/prompts.md - Workflow-specific guidance with template variables
Instructions: docs/contributing/instructions.md - Technology-specific standards with glob patterns
Skills: docs/contributing/skills.md - Task execution utilities with cross-platform scripts

Testing

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

Used /prompt-analyze to review contribution
Addressed all feedback from prompt-builder review
Verified contribution follows common standards and type-specific requirements

Required Automated Checks

The following validation commands must pass before merging:

Markdown linting: npm run lint:md
Spell checking: npm run spell-check
Frontmatter validation: npm run lint:frontmatter
Link validation: npm run lint:md-links
PowerShell analysis: npm run lint:ps

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

codecov-commenter · 2026-02-12T00:08:38Z

Codecov Report

❌ Patch coverage is 0% with 8 lines in your changes missing coverage. Please review.
✅ Project coverage is 85.34%. Comparing base (5e53271) to head (83ee4a6).

Files with missing lines	Patch %	Lines
scripts/security/Test-ActionVersionConsistency.ps1	0.00%	8 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #482      +/-   ##
==========================================
- Coverage   85.34%   85.34%   -0.01%     
==========================================
  Files          23       23              
  Lines        4476     4475       -1     
==========================================
- Hits         3820     3819       -1     
  Misses        656      656

Flag	Coverage Δ
pester	`85.34% <0.00%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
scripts/security/Test-ActionVersionConsistency.ps1	`84.06% <0.00%> (+0.45%)`	⬆️

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull request overview

This PR refactors three utility scripts to use the shared CIHelpers module, replacing inline CI annotation patterns with standardized CIHelpers function calls. The changes include updating Test-ActionVersionConsistency.ps1 to use Write-CIAnnotation instead of raw ::error:: output, and adding test coverage for error propagation in Generate-PrReference.ps1 and Get-VerifiedDownload.ps1.

Changes:

Replaced inline $env:GITHUB_ACTIONS checks and ::error:: output with Write-CIAnnotation calls in Test-ActionVersionConsistency.ps1
Added CIHelpers module imports and cleanup to test files for Generate-PrReference.ps1 and Get-VerifiedDownload.ps1
Added error propagation tests to verify error handling paths

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.

File	Description
scripts/tests/lib/Get-VerifiedDownload.Tests.ps1	Adds CIHelpers import/cleanup and error propagation test, plus CIHelpers function mocks
scripts/tests/dev-tools/Generate-PrReference.Tests.ps1	Adds CIHelpers import/cleanup and error propagation test, plus CIHelpers function mocks
scripts/security/Test-ActionVersionConsistency.ps1	Replaces inline CI pattern with Write-CIAnnotation in catch block

scripts/tests/dev-tools/Generate-PrReference.Tests.ps1

scripts/tests/lib/Get-VerifiedDownload.Tests.ps1

scripts/tests/dev-tools/Generate-PrReference.Tests.ps1

scripts/tests/lib/Get-VerifiedDownload.Tests.ps1

scripts/tests/dev-tools/Generate-PrReference.Tests.ps1

scripts/tests/lib/Get-VerifiedDownload.Tests.ps1

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

scripts/tests/lib/Get-VerifiedDownload.Tests.ps1

scripts/tests/dev-tools/Generate-PrReference.Tests.ps1

chaosdinosaur · 2026-02-12T17:10:15Z

@copilot open a new pull request to apply changes based on the comments in this thread

…est cleanup - Replace inline $env:GITHUB_ACTIONS check and ::error:: output with Write-CIAnnotation in Test-ActionVersionConsistency.ps1 - Standardize entry point guard to $script:SkipMain pattern - Add CIHelpers module cleanup in AfterAll for Generate-PrReference and Get-VerifiedDownload test files 🔧 - Generated by Copilot

WilliamBerryiii

Nice!

WilliamBerryiii · 2026-02-13T01:27:46Z

Thank you for this contribution, @chaosdinosaur! 🎉 Your refactoring of the dev-tools and lib scripts to use the CIHelpers module — along with the added test coverage for error propagation and CI annotation handling — cleans up the codebase and makes it more consistent. We appreciate the effort you put into this.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

scripts/security/Test-ActionVersionConsistency.ps1

scripts/tests/lib/Get-VerifiedDownload.Tests.ps1

…ttern - extract Invoke-ActionVersionConsistency function with full param block - replace HVE_SKIP_MAIN env var with MyInvocation.InvocationName guard - add Remove-Module CIHelpers cleanup to test AfterAll block 🔧 - Generated by Copilot

- pipe Export-ConsistencyReport to Out-Host inside Invoke-ActionVersionConsistency - prevents Write-Output json from contaminating function return value 🐛 - Generated by Copilot

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

scripts/security/Test-ActionVersionConsistency.ps1

…ency 🔧 - Generated by Copilot

WilliamBerryiii · 2026-02-13T02:49:45Z

@agreaves-ms or @katriendg ... can you do a quick review of this because I made some small changes on the cleanup for the tests.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

scripts/security/Test-ActionVersionConsistency.ps1

katriendg

The changes themselves look OK to me, though I believe the PR description is no longer accurate. Maybe this is due to changes having happened and merged from main, but it was a bit confusing to try and see what has been changed...
There are no new calls to CIHelpers as far as I can see, or added tests and mocking to test files which I don't really see?

Probably best to rebuild the PR description to match.
Thanks a lot in any case and sorry if our fast changes are making it harder for you :)

scripts/security/Test-ActionVersionConsistency.ps1

katriendg

And I meant to approve...

WilliamBerryiii · 2026-02-13T16:19:23Z

Addressing the two remaining unresolved review threads:

1. Attribute ordering (`[CmdletBinding()]` before `[OutputType([int])]`) — @copilot-pull-request-reviewer

Fixed in commit c12758b. [CmdletBinding()] now precedes [OutputType([int])] on Invoke-ActionVersionConsistency, matching codebase convention.

2. Code coverage for `Invoke-ActionVersionConsistency` — @katriendg

Ran Pester with JaCoCo code coverage against Test-ActionVersionConsistency.ps1:

Metric	Value
Overall coverage	82.47% (207/251 commands hit)
Threshold	75%
Tests	47/47 passing

Invoke-ActionVersionConsistency (lines 380–414) shows 34 missed commands in the Pester in-process coverage report. This is expected because the Main Script Execution tests invoke the script via pwsh -NoProfile -Command subprocesses, which Pester's coverage instrumentation cannot track across process boundaries. Those 9 subprocess tests exercise all code paths in the function — exit codes for version mismatches, missing version comments, FailOnMismatch, FailOnMissingComment, and the success path.

The function is fully tested through the existing Main Script Execution test suite; the apparent gap is a Pester coverage tracking limitation, not a testing gap.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.

🤖 I have created a release *beep* *boop* --- ## [2.3.0](hve-core-v2.2.0...hve-core-v2.3.0) (2026-02-13) ### ✨ Features * **agents:** add GitHub backlog management pipeline ([#448](#448)) ([2b4d123](2b4d123)) * **docs:** define inactivity closure policies for issues and PRs ([#452](#452)) ([5e710fd](5e710fd)) * **extension:** implement collection-based plugin distribution system ([#439](#439)) ([3156d98](3156d98)) * **instructions:** replace EVEN/ODD hardcoding with runtime milestone discovery protocol ([#486](#486)) ([ae95eb2](ae95eb2)) * **plugin:** support Copilot CLI plugin generation from collection manifests ([#496](#496)) ([e6cee85](e6cee85)) * **scripts:** enhance on-create.sh to install actionlint and PowerShell modules ([#500](#500)) ([67585f5](67585f5)) ### 🐛 Bug Fixes * **docs:** replace broken relative link with inline code reference ([#465](#465)) ([8133b36](8133b36)) * **instructions:** prevent local-only paths from leaking into GitHub issues ([#489](#489)) ([497d2fe](497d2fe)) * **workflows:** prevent release-please infinite loop on main branch ([#470](#470)) ([134bdd6](134bdd6)) * **workflows:** remove release-please skip guard that prevents tag creation ([#511](#511)) ([5e53271](5e53271)) ### 📚 Documentation * **agents:** add GitHub Backlog Manager documentation and agent catalog ([#503](#503)) ([5e818ce](5e818ce)) * align CONTRIBUTING.md with docs/contributing/ guides ([#445](#445)) ([73ef6aa](73ef6aa)) ### ♻️ Refactoring * **scripts:** refactor dev-tools and lib scripts to use CIHelpers module ([#482](#482)) ([fdf9145](fdf9145)) * **scripts:** standardize PowerShell entry point guard pattern ([#477](#477)) ([6b84a8e](6b84a8e)) ### 🔧 Maintenance * **config:** standardize action mappings in artifact-retention.yml ([#487](#487)) ([7927db2](7927db2)) * **deps-dev:** bump cspell from 9.6.2 to 9.6.4 in the npm-dependencies group ([#461](#461)) ([c788095](c788095)) * **deps:** bump actions/setup-python from 5.1.1 to 6.2.0 in the github-actions group ([#462](#462)) ([69ef3c9](69ef3c9)) * **security:** add SBOM artifact retention policy ([#479](#479)) ([8031557](8031557)), closes [#453](#453) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: hve-core-release-please[bot] <254602402+hve-core-release-please[bot]@users.noreply.github.com>

Copilot AI review requested due to automatic review settings February 12, 2026 00:06

Copilot started reviewing on behalf of chaosdinosaur February 12, 2026 00:06 View session

Copilot AI reviewed Feb 12, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings February 12, 2026 00:29

Copilot started reviewing on behalf of chaosdinosaur February 12, 2026 00:30 View session

Copilot AI reviewed Feb 12, 2026

View reviewed changes

WilliamBerryiii mentioned this pull request Feb 12, 2026

refactor(scripts): standardize PowerShell entry point guard pattern #477

Merged

28 tasks

chaosdinosaur marked this pull request as ready for review February 12, 2026 16:53

chaosdinosaur requested a review from a team as a code owner February 12, 2026 16:53

Copilot AI review requested due to automatic review settings February 12, 2026 16:53

Copilot started reviewing on behalf of chaosdinosaur February 12, 2026 16:54 View session

Copilot AI reviewed Feb 12, 2026

View reviewed changes

scripts/tests/lib/Get-VerifiedDownload.Tests.ps1 Show resolved Hide resolved

scripts/tests/dev-tools/Generate-PrReference.Tests.ps1 Show resolved Hide resolved

chaosdinosaur force-pushed the refactor/scripts-cihelpers-devtools-lib-352 branch from e3c2e5d to e8642ba Compare February 12, 2026 23:54

chaosdinosaur and others added 2 commits February 12, 2026 23:56

Merge branch 'main' into refactor/scripts-cihelpers-devtools-lib-352

4e485e6

Merge branch 'main' into refactor/scripts-cihelpers-devtools-lib-352

5b15736

Copilot AI review requested due to automatic review settings February 13, 2026 01:23

Copilot started reviewing on behalf of WilliamBerryiii February 13, 2026 01:24 View session

WilliamBerryiii approved these changes Feb 13, 2026

View reviewed changes

Copilot AI reviewed Feb 13, 2026

View reviewed changes

scripts/security/Test-ActionVersionConsistency.ps1 Outdated Show resolved Hide resolved

scripts/security/Test-ActionVersionConsistency.ps1 Outdated Show resolved Hide resolved

scripts/tests/lib/Get-VerifiedDownload.Tests.ps1 Show resolved Hide resolved

WilliamBerryiii added 2 commits February 12, 2026 18:13

fix(scripts): prevent pipeline pollution from Export-ConsistencyReport

895d9fb

- pipe Export-ConsistencyReport to Out-Host inside Invoke-ActionVersionConsistency - prevents Write-Output json from contaminating function return value 🐛 - Generated by Copilot

Copilot AI review requested due to automatic review settings February 13, 2026 02:32

Copilot AI reviewed Feb 13, 2026

View reviewed changes

scripts/security/Test-ActionVersionConsistency.ps1 Show resolved Hide resolved

scripts/security/Test-ActionVersionConsistency.ps1 Show resolved Hide resolved

fix(scripts): add OutputType attribute to Invoke-ActionVersionConsist…

8217d2a

…ency 🔧 - Generated by Copilot

Merge branch 'main' into refactor/scripts-cihelpers-devtools-lib-352

2577ca9

Copilot AI review requested due to automatic review settings February 13, 2026 14:33

Copilot started reviewing on behalf of katriendg February 13, 2026 14:33 View session

Copilot AI reviewed Feb 13, 2026

View reviewed changes

scripts/security/Test-ActionVersionConsistency.ps1 Show resolved Hide resolved

katriendg reviewed Feb 13, 2026

View reviewed changes

scripts/security/Test-ActionVersionConsistency.ps1 Show resolved Hide resolved

katriendg approved these changes Feb 13, 2026

View reviewed changes

Merge branch 'main' into refactor/scripts-cihelpers-devtools-lib-352

66ee073

Merge branch 'main' into refactor/scripts-cihelpers-devtools-lib-352

83ee4a6

Copilot AI review requested due to automatic review settings February 13, 2026 16:20

Copilot started reviewing on behalf of WilliamBerryiii February 13, 2026 16:21 View session

Copilot AI reviewed Feb 13, 2026

View reviewed changes

WilliamBerryiii merged commit fdf9145 into microsoft:main Feb 13, 2026
24 checks passed

hve-core-release-please bot mentioned this pull request Feb 13, 2026

chore(main): release hve-core 2.3.0 #463

Merged

chaosdinosaur deleted the refactor/scripts-cihelpers-devtools-lib-352 branch February 13, 2026 16:47

Conversation

chaosdinosaur commented Feb 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

Description

Related Issue(s)

Type of Change

Sample Prompts (for AI Artifact Contributions)

Testing

Checklist

Required Checks

AI Artifact Contributions

Required Automated Checks

Security Considerations

Additional Notes

Uh oh!

codecov-commenter commented Feb 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

chaosdinosaur commented Feb 12, 2026

Uh oh!

WilliamBerryiii left a comment

Choose a reason for hiding this comment

Uh oh!

WilliamBerryiii commented Feb 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

WilliamBerryiii commented Feb 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

katriendg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

katriendg left a comment

Choose a reason for hiding this comment

Uh oh!

WilliamBerryiii commented Feb 13, 2026

1. Attribute ordering ([CmdletBinding()] before [OutputType([int])]) — @copilot-pull-request-reviewer

2. Code coverage for Invoke-ActionVersionConsistency — @katriendg

Uh oh!

Copilot AI left a comment

chaosdinosaur commented Feb 12, 2026 •

edited

Loading

codecov-commenter commented Feb 12, 2026 •

edited

Loading

1. Attribute ordering (`[CmdletBinding()]` before `[OutputType([int])]`) — @copilot-pull-request-reviewer

2. Code coverage for `Invoke-ActionVersionConsistency` — @katriendg