Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Changelog info #21172

Merged
merged 15 commits into from
Mar 22, 2023
Merged

Add Changelog info #21172

merged 15 commits into from
Mar 22, 2023

Conversation

greathongtu
Copy link
Contributor

@greathongtu greathongtu commented Mar 10, 2023

Description

Add a column of Changelog information to azure-powershell-modules.md.

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 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 adjust version of module manually in pull request

@azure-client-tools-bot-prd
Copy link

azure-client-tools-bot-prd bot commented Mar 10, 2023

️✔️Az.Accounts
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows

@greathongtu greathongtu requested review from a1exwang and isra-fel and removed request for a1exwang March 14, 2023 02:08
Copy link
Member

@isra-fel isra-fel left a comment

Choose a reason for hiding this comment

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

  1. Please format the markdown file before committing, ALT+SHITF+F in vscode
  2. Changelog reference -> Changelog, shorten the table
  3. Do not use inline links in long tables. It makes the table unreadable. I've pushed a commit to your branch, please use it as an example to update the table.

@isra-fel isra-fel self-assigned this Mar 14, 2023
Copy link
Member

@isra-fel isra-fel left a comment

Choose a reason for hiding this comment

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

Can you (write a script to) check if the all the link works?
I checked SecurityInsights and it's 404.

@isra-fel
Copy link
Member

/azp run azure-powershell - security-tools

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 1 pipeline(s).

@VeryEarly VeryEarly merged commit 72f7324 into Azure:main Mar 22, 2023
@greathongtu greathongtu deleted the hongtu/addChangelog branch May 23, 2023 04:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants