-
Notifications
You must be signed in to change notification settings - Fork 1.5k
add breaking change message #9542
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
base: main
Are you sure you want to change the base?
Conversation
|
Validation for Breaking Change Starting...
Thanks for your contribution! |
|
Hi @nguyenm2151, |
|
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>
|
|
Hi @nguyenm2151 Release SuggestionsModule: acrtransfer
Notes
|
There was a problem hiding this 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 adds breaking change warnings for the acr import-pipeline create and acr export-pipeline create commands to inform users that a new required parameter --storage-access-mode will be added in a future release.
Changes:
- Added a new
_breaking_change.pyfile that registers breaking change notifications for two ACR pipeline create commands
| # -------------------------------------------------------------------------------------------- | ||
| # Copyright (c) Microsoft Corporation. All rights reserved. | ||
| # Licensed under the MIT License. See License.txt in the project root for license information. | ||
| # -------------------------------------------------------------------------------------------- | ||
|
|
||
| from azure.cli.core.breaking_change import register_logic_breaking_change | ||
|
|
||
| register_logic_breaking_change('acr export-pipeline create', 'Add required parameter --storage-access-mode', | ||
| detail='A new required parameter `--storage-access-mode` will be added. ' | ||
| 'Allowed values: `entra-mi-auth`, `storage-sas-token`.') | ||
|
|
||
|
|
||
| register_logic_breaking_change('acr import-pipeline create', 'Add required parameter --storage-access-mode', | ||
| detail='A new required parameter `--storage-access-mode` will be added. ' | ||
| 'Allowed values: `entra-mi-auth`, `storage-sas-token`.') No newline at end of file |
Copilot
AI
Jan 22, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The _breaking_change module needs to be imported in init.py for the breaking change registrations to take effect. Similar to how _help is imported, add the following import to azext_acrtransfer/init.py:
from azext_acrtransfer._breaking_change import * # pylint: disable=unused-import,unused-wildcard-import,wildcard-import
Without this import, the register_logic_breaking_change calls will never execute, and users won't see the breaking change warnings.
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
acr import-pipeline create
acr export-pipeline create
General Guidelines
azdev style <YOUR_EXT>locally? (pip install azdevrequired)python scripts/ci/test_index.py -qlocally? (pip install wheel==0.30.0required)For new extensions:
About Extension Publish
There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update
src/index.jsonautomatically.You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify
src/index.json.