Open
Conversation
️✔️AzureCLI-FullTest
|
|
Hi @AllyW, |
️✔️AzureCLI-BreakingChangeTest
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the new versioning-bot workflow in the Azure CLI extensions guidelines, explaining how version bumps are validated and how reviewers can control the process.
- Introduces a new “Extension Module Version Upgrade” section describing the versioning-bot’s role.
- Details labels for stable vs. preview releases, custom bump levels, and skipping validation.
- Links to the version validation task and explains the bot’s classification rules.
Comments suppressed due to low confidence (3)
doc/extensions/versioning_guidelines.md:153
- It would be helpful to define what qualifies as an “interface change” and link to or describe how the breaking change detection tool makes its determinations so PR authors can understand the criteria.
The version change type — breaking, feature, or bugfix — is currently determined by the breaking change detection tool.
doc/extensions/versioning_guidelines.md:160
- Consider adding a brief example or note on where exactly to apply these labels (e.g., in the GitHub PR Labels UI) to guide first-time contributors.
If there is a business justification, PR authors or reviewers can specify the version bump level by adding one of the following labels: `major`, `minor`, `patch`, or `pre` — this overrides the default rules and informs the bot which version segment to increment.
doc/extensions/versioning_guidelines.md:163
- It may be useful to clarify what happens if both a custom bump label (major/minor/patch/pre) and
skip-cal-versionare present in the same PR—specifically, which one takes precedence.
If unsure how to interact with the bot or if version validation should be bypassed for any reason, reviewers can add the `skip-cal-version` label to skip the version validation task in the pipeline.
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
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.
Related command
Description
Testing Guide
History Notes
[Component Name 1] BREAKING CHANGE:
az command a: Make some customer-facing breaking change[Component Name 2]
az command b: Add some customer-facing featureThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.