Artifact Signing module docs cleanup #29262
Conversation
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
There was a problem hiding this comment.
Pull request overview
This PR is a follow-up cleanup for the Az.ArtifactSigning module, focusing on making documentation and user-facing strings consistently refer to “artifact signing” (instead of “trusted signing”), plus a few small generated-file updates.
Changes:
- Updated multiple help markdown files (both
help/andArtifactSigning.Autorest/docs/) to replace “trusted signing” wording with “artifact signing”. - Refreshed module packaging metadata (changelog entry, manifest formatting, AutoRest pinned commit, generate-info ID).
- Minor code cleanup (removed a commented-out debug line; adjusted a cmdlet HelpMessage string).
Reviewed changes
Copilot reviewed 26 out of 26 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| src/ArtifactSigning/ArtifactSigning/help/Update-AzArtifactSigningAccount.md | Wording updates to “artifact signing” in cmdlet help. |
| src/ArtifactSigning/ArtifactSigning/help/Test-AzArtifactSigningAccountNameAvailability.md | Wording/casing updates in cmdlet help examples and descriptions. |
| src/ArtifactSigning/ArtifactSigning/help/Remove-AzArtifactSigningCertificateProfile.md | Parameter description wording update. |
| src/ArtifactSigning/ArtifactSigning/help/Remove-AzArtifactSigningAccount.md | Wording updates to “artifact signing” in help content. |
| src/ArtifactSigning/ArtifactSigning/help/New-AzArtifactSigningCertificateProfile.md | Parameter description wording update. |
| src/ArtifactSigning/ArtifactSigning/help/New-AzArtifactSigningAccount.md | Wording updates to “artifact signing” in help content. |
| src/ArtifactSigning/ArtifactSigning/help/Get-AzArtifactSigningCertificateProfile.md | Parameter description wording update. |
| src/ArtifactSigning/ArtifactSigning/help/Get-AzArtifactSigningAccount.md | Wording updates to “artifact signing” in help content. |
| src/ArtifactSigning/ArtifactSigning/help/Az.ArtifactSigning.md | Module index synopsis lines updated to “artifact signing”. |
| src/ArtifactSigning/ArtifactSigning/Helpers/CmsSigner.cs | Removed commented-out debug output line. |
| src/ArtifactSigning/ArtifactSigning/Commands/InvokeCIPolicySigning.cs | Updated user-facing HelpMessage text to “ArtifactSigning”. |
| src/ArtifactSigning/ArtifactSigning/ChangeLog.md | Added upcoming-release note describing doc/comment cleanup. |
| src/ArtifactSigning/ArtifactSigning/Az.ArtifactSigning.psd1 | Manifest regenerated/normalized (timestamps, formatting, empty arrays). |
| src/ArtifactSigning/ArtifactSigning.Autorest/generate-info.json | Updated generation ID. |
| src/ArtifactSigning/ArtifactSigning.Autorest/docs/Update-AzArtifactSigningAccount.md | Wording updates to “Artifact Signing” in generated docs. |
| src/ArtifactSigning/ArtifactSigning.Autorest/docs/Test-AzArtifactSigningAccountNameAvailability.md | Wording/casing updates in generated docs. |
| src/ArtifactSigning/ArtifactSigning.Autorest/docs/Remove-AzArtifactSigningCertificateProfile.md | Wording and example text updates in generated docs. |
| src/ArtifactSigning/ArtifactSigning.Autorest/docs/Remove-AzArtifactSigningAccount.md | Wording updates in generated docs. |
| src/ArtifactSigning/ArtifactSigning.Autorest/docs/New-AzArtifactSigningCertificateProfile.md | Wording updates in generated docs. |
| src/ArtifactSigning/ArtifactSigning.Autorest/docs/New-AzArtifactSigningAccount.md | Wording updates in generated docs. |
| src/ArtifactSigning/ArtifactSigning.Autorest/docs/Get-AzArtifactSigningCertificateProfile.md | Wording updates in generated docs. |
| src/ArtifactSigning/ArtifactSigning.Autorest/docs/Get-AzArtifactSigningAccount.md | Wording updates in generated docs. |
| src/ArtifactSigning/ArtifactSigning.Autorest/docs/Az.ArtifactSigning.md | Module-level generated docs updated (including Module Guid line). |
| src/ArtifactSigning/ArtifactSigning.Autorest/UX/Microsoft.CodeSigning/codeSigningAccounts.json | Updated command descriptions/example descriptions to “Artifact Signing”. |
| src/ArtifactSigning/ArtifactSigning.Autorest/README.md | Updated pinned swagger/spec commit hash. |
| src/ArtifactSigning/ArtifactSigning.Autorest/Properties/AssemblyInfo.cs | Assembly version/file version updated. |
|
|
||
| ### [Get-AzArtifactSigningCustomerEku](Get-AzArtifactSigningCustomerEku.md) | ||
| Retrieve Azure.CodeSigning customer Eku | ||
| Retrieve artifact signing customer Eku |
There was a problem hiding this comment.
Eku should be capitalized as the acronym EKU (Enhanced Key Usage) in this synopsis line to avoid looking like a misspelling.
| Retrieve artifact signing customer Eku | |
| Retrieve artifact signing customer EKU |
|
|
||
| ### [New-AzArtifactSigningAccount](New-AzArtifactSigningAccount.md) | ||
| create a trusted Signing Account. | ||
| create an artifact signing account. |
There was a problem hiding this comment.
This synopsis line starts with a lowercase verb (create). For consistency with the other entries in this module index (and standard sentence casing), capitalize it (e.g., Create ...).
| ## EXAMPLES | ||
|
|
||
| ### Example 1: Test The Availability Of An Used Artifact signing Account Name | ||
| ### Example 1: Test The Availability Of An Used Artifact Signing Account Name |
There was a problem hiding this comment.
The example heading uses incorrect grammar: An Used should be reworded (e.g., a used / an already-used / an in-use) to be grammatically correct.
| ### Example 1: Test The Availability Of An Used Artifact Signing Account Name | |
| ### Example 1: Test The Availability Of A Used Artifact Signing Account Name |
| ### Example 1: Test The Availability Of An Used Artifact signing Account Name | ||
| ### Example 1: Test The Availability Of An Used Artifact Signing Account Name | ||
| ```powershell | ||
| Test-AzArtifactSigningAccountNameAvailability -Name unavaliable |
There was a problem hiding this comment.
The example uses unavaliable as the name value; this is a misspelling of unavailable and should be corrected to avoid propagating the typo into user scripts.
| ## EXAMPLES | ||
|
|
||
| ### Example 1: Test The Availability Of An Used Artifact signing Account Name | ||
| ### Example 1: Test The Availability Of An Used Artifact Signing Account Name |
There was a problem hiding this comment.
The example heading uses incorrect grammar: An Used should be reworded (e.g., a used / an already-used / an in-use) to be grammatically correct.
| ### Example 1: Test The Availability Of An Used Artifact Signing Account Name | |
| ### Example 1: Test The Availability Of a Used Artifact Signing Account Name |
| ### Example 1: Test The Availability Of An Used Artifact signing Account Name | ||
| ### Example 1: Test The Availability Of An Used Artifact Signing Account Name | ||
| ```powershell | ||
| Test-AzArtifactSigningAccountNameAvailability -Name unavaliable |
There was a problem hiding this comment.
The example uses unavaliable as the name value; this is a misspelling of unavailable and should be corrected to avoid propagating the typo into user scripts.
| --- | ||
| Module Name: Az.ArtifactSigning | ||
| Module Guid: ff7c6523-4ad4-433c-9cb6-568e4b2daff2 | ||
| Module Guid: 323532e3-ac50-4624-8d7e-91b9a220d6a2 | ||
| Download Help Link: https://learn.microsoft.com/powershell/module/az.artifactsigning |
There was a problem hiding this comment.
The Module Guid value in this doc appears to have changed. Module GUIDs are typically treated as stable identifiers for a module’s documentation; please confirm this is intentional and, if not, revert it (or align it with the module’s actual manifest GUID).
|
|
||
| ### [Update-AzArtifactSigningAccount](Update-AzArtifactSigningAccount.md) | ||
| update a trusted signing account. | ||
| update an artifact signing account. |
There was a problem hiding this comment.
This synopsis line starts with a lowercase verb (update). For consistency with the other entries in this module index (and standard sentence casing), capitalize it (e.g., Update ...).
| ParameterSetName = ByAccountProfileNameParameterSet, | ||
| ValueFromPipelineByPropertyName = true, | ||
| HelpMessage = "The endpoint url used to submit request to Azure TrustedSigning.")] | ||
| HelpMessage = "The endpoint url used to submit request to Azure ArtifactSigning.")] |
There was a problem hiding this comment.
This HelpMessage still uses url instead of URL. Since this string is shown to users, please use standard capitalization (and consider applying the same change to the other related HelpMessage strings in this cmdlet for consistency).
| HelpMessage = "The endpoint url used to submit request to Azure ArtifactSigning.")] | |
| HelpMessage = "The endpoint URL used to submit request to Azure ArtifactSigning.")] |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
Description
This is a follow up to the PR #29104 where it does a bit of cleanup of inconsistent code comments or error messages.
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.