fix(#187): clean up public help surface#192
Merged
Conversation
Remove Invoke-NovaCli from user-facing PlatyPS help, drop legacy Invoke-NovaRelease PublishOption guidance, and update help tests to match the intended public documentation surface.
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Code Coverage Gates Passed
Overall Coverage: 100.0%
(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: 100.0% covered >= threshold = 95% - Action:
You have 281 files with a sum of 2874 covered and 1 uncovered lines of code.
- Pass/Fail Reason:
-
New & Changed Code Coverage
- Pass/Fail Reason:
No executable lines of code changed. (The change touched 0 files).
- Pass/Fail Reason:
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Invoke-NovaClifrom the user-facing PlatyPS/public help surface and removed legacyInvoke-NovaRelease -PublishOptionguidance from public help.tests/NovaCommandModel.Tests.ps1so user-facing help discovery does not exposeInvoke-NovaCliandInvoke-NovaReleasehelp does not document-PublishOption.Invoke-NovaCliand legacy release publish-option guidance from PlatyPS/public help. #187 in line with Align NovaModuleTools end-user docs and public help with explicit CLI vs PowerShell surfaces. #184: public help should keep the PowerShell help surface explicit and should not carry legacy or internal-facing guidance.Invoke-NovaCliand legacy release publish-option guidance from PlatyPS/public help. #187. Related to Align NovaModuleTools end-user docs and public help with explicit CLI vs PowerShell surfaces. #184.Affected area
novaCLI or command routingproject.jsonhandlingREADME.md,CONTRIBUTING.md, repository workflow docs)docs/*.html)docs/NovaModuleTools/en-US/*.md)src/resources/example/project.json, workflow dependencies, release tooling)Review guidance
docs/NovaModuleTools/en-US/Invoke-NovaRelease.md,docs/NovaModuleTools/en-US/NovaModuleTools.md, and the removeddocs/NovaModuleTools/en-US/Invoke-NovaCli.md.tests/NovaCommandModel.Tests.ps1to see the regression coverage that keeps the help surface aligned with the intended public documentation boundary.Invoke-NovaClistill exists at runtime, but it is no longer treated as part of the user-facing PlatyPS help surface.Validation
Invoke-NovaBuildTest-NovaBuild./scripts/build/Invoke-ScriptAnalyzerCI.ps1./scripts/build/ci/Invoke-NovaModuleToolsCI.ps1% nova build,% nova test,% nova merge,% nova deploy,% nova publish,% nova release,% nova update,% nova notification, or% nova initas relevant)Validation notes:
Documentation and release follow-up
README.mdreviewed and updated if contributor workflow, architecture, CI, release, or automation changedCONTRIBUTING.mdreviewed and updated if contribution expectations or review guidance changedCHANGELOG.mdreviewed and updated if the change matters to users, maintainers, or contributorsRELEASE_NOTE.mdreviewed and updated if the change affects public cmdlet usage, CLI usage, configurationsemantics, or migration expectations
docs/NovaModuleTools/en-US/help updated if a public command or CLI behavior changeddocs/*.htmlupdated if end-user workflows or examples changedsrc/resources/example/reviewed and updated if the real-world project layout, package model, or upload workflowchanged
Maintainability, compatibility, and risk
Risk, rollout, or rollback notes:
Important
Do not use a public pull request to disclose a vulnerability before coordinated handling.
Use the private reporting path in
SECURITY.mdfor new security issues.