Skip to content

Conversation

@MoChilia
Copy link
Member

@MoChilia MoChilia commented Aug 8, 2022

Description

Add help message for each parameter. Remove the redundant parameter $OutputScriptsInFile.

Test PR: #19172

An overview of help messages output by help Measure-MarkdownOrScript.ps1
image
image

Checklist

  • SHOULD select appropriate branch. Cmdlets from Autorest.PowerShell should go to generation branch.
  • SHOULD make the title of PR clear and informative, and in the present imperative tense.
  • SHOULD update ChangeLog.md file(s) appropriately
    • For any service, the ChangeLog.md file can be found at 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. Add changelog in description section if PR goes into generation branch.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD have approved design review for the changes in this repository (Microsoft internal only) with following situations
    • Create new module from the scratch
    • Create new resource types which are not easy to conform to Azure PowerShell Design Guidelines
    • Create new resource type which name doesn't use module name as prefix
    • Have design question before implementation
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT introduce breaking changes in Az minor release except preview version.
  • SHOULD NOT change version of module in pull request

@MoChilia MoChilia requested a review from isra-fel August 8, 2022 05:42
[string[]]$ScriptPath,
[string[]]$RulePaths,
[Parameter(Mandatory, ParameterSetName = "Script")]
[string]$CodeMapPath,
Copy link
Member

Choose a reason for hiding this comment

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

Code map should be transparent to users so it should be optional.
As a user, I only want to know the error is on which line. I don't care where the code map file is.

@isra-fel isra-fel merged commit 3648280 into main Aug 9, 2022
@isra-fel isra-fel deleted the shiying/ci-example-param branch August 9, 2022 08:41
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.

3 participants