Skip to content

Restore deploy help related links#231

Merged
stiwicourage merged 2 commits into
developfrom
feature/215-refactordeploy-novapackage-align-with-terminal-ux-design-principles
May 24, 2026
Merged

Restore deploy help related links#231
stiwicourage merged 2 commits into
developfrom
feature/215-refactordeploy-novapackage-align-with-terminal-ux-design-principles

Conversation

@stiwicourage

Copy link
Copy Markdown
Owner

Summary

Affected area

  • nova CLI or command routing
  • Public PowerShell cmdlet behavior
  • Scaffolding or project.json handling
  • Build, test, analyzer, coverage, or CI helper flow
  • Package, raw upload, or package metadata workflow
  • Publish, release, or GitHub Actions automation
  • Self-update or notification preference behavior
  • Contributor documentation (README.md, CONTRIBUTING.md, repository workflow docs)
  • End-user docs (docs/*.html)
  • Command help (docs/NovaModuleTools/en-US/*.md)
  • src/resources/example/
  • Dependency or manifest changes (project.json, workflow dependencies, release tooling)
  • Security-sensitive change
  • Documentation-only change
  • Agentic Copilot Workflow + scaffold mirror + scaffold-sync guardrail test.
  • Other

Review guidance

  • Start with src/private/quality/GetNovaTestWorkflowContext.ps1 for the coverage fix and src/public/DeployNovaPackage.ps1 for the user-facing upload UX change.
  • Main files: src/private/quality/GetNovaTestWorkflowContext.ps1, tests/private/quality/GetNovaTestWorkflowContext.Tests.ps1, tests/ProjectPesterCoverageConfiguration.Tests.ps1, src/public/DeployNovaPackage.ps1, src/private/package/InvokeNovaPackageUploadWorkflow.ps1, src/private/package/InvokeNovaPackageArtifactUpload.ps1, src/private/package/WriteNovaPackageUploadWorkflowContext.ps1, src/private/package/WriteNovaPackageUploadResultOutput.ps1, tests/public/DeployNovaPackage.Tests.ps1, tests/private/package/*.Tests.ps1, docs/NovaModuleTools/en-US/Deploy-NovaPackage.md, CHANGELOG.md, and RELEASE_NOTE.md.
  • No release automation semantics changed. The main trade-off is additional terminal-visible feedback during raw uploads while preserving the existing output object contract for automation.

Validation

  • Invoke-NovaBuild
  • Test-NovaBuild
  • ./scripts/build/Invoke-ScriptAnalyzerCI.ps1
  • ./scripts/build/ci/Invoke-NovaModuleToolsCI.ps1
  • Targeted Nova workflow validated (% nova build, % nova test, % nova merge, % nova deploy, % nova publish, % nova release, % nova update, % nova notification, or % nova init as relevant)
  • Docs/example only; executable validation not needed

Validation notes:

pwsh -NoLogo -NoProfile -File ./run.ps1
./scripts/build/Invoke-ScriptAnalyzerCI.ps1
Test-NovaBuild
./scripts/build/ci/Invoke-NovaModuleToolsCI.ps1 -OutputDirectory ./artifacts
Import-Module ./dist/NovaModuleTools/NovaModuleTools.psd1 -Force
Update-MarkdownCommandHelp -Path ./docs/NovaModuleTools/en-US/Deploy-NovaPackage.md
Test-MarkdownCommandHelp -Path ./docs/NovaModuleTools/en-US/Deploy-NovaPackage.md -DetailView

Relevant exercised scenarios:
- coverage run now includes nested private helpers in artifacts/coverage.xml and restores overall coverage to ~99.43%
- Deploy-NovaPackage now shows pre-flight context, multi-artifact progress, and a concise completion hint
- help footer regression was fixed by restoring the RELATED LINKS section

Documentation and release follow-up

  • README.md reviewed and updated if contributor workflow, architecture, CI, release, or automation changed
  • CONTRIBUTING.md reviewed and updated if contribution expectations or review guidance changed
  • CHANGELOG.md reviewed and updated if the change matters to users, maintainers, or contributors
  • RELEASE_NOTE.md reviewed and updated if the change affects public cmdlet usage, CLI usage, configuration semantics, or migration expectations
  • docs/NovaModuleTools/en-US/ help updated if a public command or CLI behavior changed
  • docs/*.html updated if end-user workflows or examples changed
  • src/resources/example/ reviewed and updated if the real-world project layout, package model, or upload workflow changed
  • No documentation, changelog, release-note, or example updates were needed

Maintainability, compatibility, and risk

  • Code Health / maintainability impact considered
  • No breaking change
  • Breaking change
  • Security-sensitive change
  • CI, workflow, or release-pipeline impact
  • Dependency-review impact

Risk, rollout, or rollback notes:

Compatibility impact is low:
- coverage-path expansion preserves the existing project.json shape and makes nested helpers measurable again
- Deploy-NovaPackage keeps SupportsShouldProcess and the existing result-object shape, adding only terminal feedback around the workflow

Release impact:
- prepared under the next-stable-release assumption
- no Publish.yml or main/develop release semantics changed

Rollback:
- revert the coverage resolver change in GetNovaTestWorkflowContext.ps1
- revert the Deploy-NovaPackage helper additions and help/changelog/release-note updates

Important

Do not use a public pull request to disclose a vulnerability before coordinated handling.
Use the private reporting path in SECURITY.md for new security issues.

@stiwicourage stiwicourage linked an issue May 24, 2026 that may be closed by this pull request
20 tasks
@github-actions

github-actions Bot commented May 24, 2026

Copy link
Copy Markdown
Contributor

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

codescene-delta-analysis[bot]

This comment was marked as outdated.

codescene-delta-analysis[bot]

This comment was marked as outdated.

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Quality Gate Profile: Pay Down Tech Debt
Install CodeScene MCP: safeguard and uplift AI-generated code. Catch issues early with our IDE extension and CLI tool.

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Coverage Gates Passed
Overall Coverage: 99.4% (required = 95%)
New & Changed Code Coverage: 100% (required = 99%)

Review details by gate
  • Overall Coverage

    • Pass/Fail Reason:
      The overall coverage gate was checked for all code and meets the goal: 99.4% covered >= threshold = 95%
    • Action:
      You have 292 files with a sum of 3280 covered and 19 uncovered lines of code.
  • New & Changed Code Coverage

    • Pass/Fail Reason:
      New or changed code meets coverage goal: 100% covered >= threshold = 99%
    • Action:
      You modified 5 files, and covered 52 added/modified lines of code.

@stiwicourage
stiwicourage merged commit 7fb5186 into develop May 24, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant