Skip to content

[ACR] add breaking change message#9659

Open
nguyenm2151 wants to merge 11 commits intoAzure:mainfrom
nguyenm2151:nguyenma/breakingchange
Open

[ACR] add breaking change message#9659
nguyenm2151 wants to merge 11 commits intoAzure:mainfrom
nguyenm2151:nguyenma/breakingchange

Conversation

@nguyenm2151
Copy link


This checklist is used to make sure that common guidelines for a pull request are followed.

Related command

General Guidelines

  • Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
  • Have you run python scripts/ci/test_index.py -q locally? (pip install wheel==0.30.0 required)
  • My extension version conforms to the Extension version schema

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.json automatically.
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.

Copilot AI review requested due to automatic review settings March 7, 2026 03:35
@azure-client-tools-bot-prd
Copy link

azure-client-tools-bot-prd bot commented Mar 7, 2026

⚠️Azure CLI Extensions Breaking Change Test
⚠️acrtransfer
rule cmd_name rule_message suggest_message
⚠️ 1003 - CmdPropAdd acr export-pipeline create cmd acr export-pipeline create added property deprecate_info_target
⚠️ 1003 - CmdPropAdd acr import-pipeline create cmd acr import-pipeline create added property deprecate_info_target

@yonzhan
Copy link
Collaborator

yonzhan commented Mar 7, 2026

Thank you for your contribution! We will review the pull request and get back to you soon.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 7, 2026

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).
After that please run the following commands to enable git hooks:

pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>

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

Adds Azure CLI “breaking change” announcements to the acrtransfer extension for upcoming required parameters on pipeline create commands, along with a new scenario test and version bump.

Changes:

  • Register breaking change announcements for acr export-pipeline create and acr import-pipeline create regarding the upcoming required --storage-access-mode parameter.
  • Bump acrtransfer extension version to 1.1.1b1 and add release note entry.
  • Add a scenario test + recording for acr import-pipeline list and clean up an empty/placeholder test file.

Reviewed changes

Copilot reviewed 7 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/acrtransfer/setup.py Bumps extension version to 1.1.1b1.
src/acrtransfer/HISTORY.rst Adds release notes for the breaking change announcement.
src/acrtransfer/azext_acrtransfer/_breaking_change.py Registers breaking change notifications for pipeline create commands.
src/acrtransfer/azext_acrtransfer/init.py Imports breaking change module to trigger registration.
src/acrtransfer/azext_acrtransfer/tests/init.py Adds test package initializer.
src/acrtransfer/azext_acrtransfer/tests/latest/init.py Adds latest tests package initializer.
src/acrtransfer/azext_acrtransfer/tests/latest/test_acrtransfer_scenario.py Adds scenario test covering acr import-pipeline list.
src/acrtransfer/azext_acrtransfer/tests/latest/test_acrtransfer_scenario Removes placeholder/empty test artifact.
src/acrtransfer/azext_acrtransfer/tests/latest/recordings/test_acrtransfer_import_pipeline_list.yaml Adds recording for the new scenario test.

Comment on lines +6 to +17
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`.',
doc_link="https://aka.ms/acr/transfer")


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`.',
doc_link="https://aka.ms/acr/transfer")
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

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

This breaking change is specifically about introducing a new required flag. For consistency with other extensions (and to generate a standardized breaking-change message), prefer using register_required_flag_breaking_change(command, flag, ...) instead of register_logic_breaking_change. Also consider specifying a target version (or otherwise indicating when the flag becomes required) so the announcement is actionable.

Suggested change
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`.',
doc_link="https://aka.ms/acr/transfer")
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`.',
doc_link="https://aka.ms/acr/transfer")
from azure.cli.core.breaking_change import register_required_flag_breaking_change
register_required_flag_breaking_change('acr export-pipeline create', '--storage-access-mode',
detail='A new required parameter `--storage-access-mode` will be added. '
'Allowed values: `entra-mi-auth`, `storage-sas-token`.',
doc_link="https://aka.ms/acr/transfer")
register_required_flag_breaking_change('acr import-pipeline create', '--storage-access-mode',
detail='A new required parameter `--storage-access-mode` will be added. '
'Allowed values: `entra-mi-auth`, `storage-sas-token`.',
doc_link="https://aka.ms/acr/transfer")

Copilot uses AI. Check for mistakes.
@github-actions
Copy link
Contributor

github-actions bot commented Mar 7, 2026

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@nguyenm2151
Copy link
Author

/azp run

@azure-pipelines
Copy link

Commenter does not have sufficient privileges for PR 9659 in repo Azure/azure-cli-extensions

@nguyenm2151
Copy link
Author

@yonzhan can you help me trigger the CI

@yonzhan
Copy link
Collaborator

yonzhan commented Mar 7, 2026

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 2 pipeline(s).

@yonzhan yonzhan requested a review from yanzhudd March 7, 2026 15:26
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@nguyenm2151
Copy link
Author

@yanzhudd the test says that I've modified index.json but i havent. Is there anyway to fix this

image

@nguyenm2151
Copy link
Author

@yanzhudd can i get help for this

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