Skip to content

Artifact Signing module docs cleanup #29262

Merged
VeryEarly merged 5 commits intoAzure:mainfrom
Jaxelr:jaxel/artifact-signing-dep-update
Mar 14, 2026
Merged

Artifact Signing module docs cleanup #29262
VeryEarly merged 5 commits intoAzure:mainfrom
Jaxelr:jaxel/artifact-signing-dep-update

Conversation

@Jaxelr
Copy link
Member

@Jaxelr Jaxelr commented Mar 11, 2026

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

  • SHOULD update ChangeLog.md file(s) appropriately
    • Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
      • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT adjust version of module manually in pull request

Copilot AI review requested due to automatic review settings March 11, 2026 02:40
@azure-client-tools-bot-prd
Copy link

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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/ and ArtifactSigning.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
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

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

Eku should be capitalized as the acronym EKU (Enhanced Key Usage) in this synopsis line to avoid looking like a misspelling.

Suggested change
Retrieve artifact signing customer Eku
Retrieve artifact signing customer EKU

Copilot uses AI. Check for mistakes.

### [New-AzArtifactSigningAccount](New-AzArtifactSigningAccount.md)
create a trusted Signing Account.
create an artifact signing account.
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

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

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 ...).

Copilot uses AI. Check for mistakes.
## 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
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
### Example 1: Test The Availability Of An Used Artifact Signing Account Name
### Example 1: Test The Availability Of A Used Artifact Signing Account Name

Copilot uses AI. Check for mistakes.
### 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
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
## 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
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
### Example 1: Test The Availability Of An Used Artifact Signing Account Name
### Example 1: Test The Availability Of a Used Artifact Signing Account Name

Copilot uses AI. Check for mistakes.
### 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
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
Comment on lines 1 to 4
---
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
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

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

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).

Copilot uses AI. Check for mistakes.

### [Update-AzArtifactSigningAccount](Update-AzArtifactSigningAccount.md)
update a trusted signing account.
update an artifact signing account.
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

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

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 ...).

Copilot uses AI. Check for mistakes.
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.")]
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

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

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).

Suggested change
HelpMessage = "The endpoint url used to submit request to Azure ArtifactSigning.")]
HelpMessage = "The endpoint URL used to submit request to Azure ArtifactSigning.")]

Copilot uses AI. Check for mistakes.
@NoriZC
Copy link
Contributor

NoriZC commented Mar 11, 2026

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@NoriZC
Copy link
Contributor

NoriZC commented Mar 14, 2026

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@VeryEarly VeryEarly enabled auto-merge (squash) March 14, 2026 02:07
@VeryEarly VeryEarly merged commit 2995ff0 into Azure:main Mar 14, 2026
12 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

Development

Successfully merging this pull request may close these issues.

4 participants