azure-cli-extensions icon indicating copy to clipboard operation
azure-cli-extensions copied to clipboard

[dataprotection] Correct command example for dpp blobs

Open IannGeorges opened this issue 9 months ago • 12 comments

This PR is removing an incorrect parameter from the command documentation. VaultStore does not support restorable-time-range for recovery point since they are discrete RPs & not continuous.

Docs: https://learn.microsoft.com/en-us/cli/azure/dataprotection/restorable-time-range?view=azure-cli-latesthttps://learn.microsoft.com/en-us/cli/azure/dataprotection/restorable-time-range?view=azure-cli-latest


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

Related command

General Guidelines

  • [X] Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
  • [X] Have you run python scripts/ci/test_index.py -q locally? (pip install wheel==0.30.0 required)
  • [X] 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.

IannGeorges avatar Mar 31 '25 16:03 IannGeorges

⚠️Azure CLI Extensions Breaking Change Test
⚠️dataprotection
rule cmd_name rule_message suggest_message
⚠️ 1010 - ParaPropUpdate dataprotection restorable-time-range find cmd dataprotection restorable-time-range find update parameter source_data_store_type: updated property choices from ['ArchiveStore', 'OperationalStore', 'VaultStore'] to ['ArchiveStore', 'OperationalStore']

Hi @IannGeorges, Since the current milestone time is less than 7 days, this pr will be reviewed in the next milestone.

Hi @IannGeorges, Please write the description of changes which can be perceived by customers into HISTORY.rst. If you want to release a new extension version, please update the version in setup.py as well.

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

yonzhan avatar Mar 31 '25 16:03 yonzhan

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>

github-actions[bot] avatar Mar 31 '25 16:03 github-actions[bot]

CodeGen Tools Feedback Collection

Thank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey

github-actions[bot] avatar Mar 31 '25 16:03 github-actions[bot]

Hi @IannGeorges

Release Suggestions

Module: dataprotection

  • Please log updates into to src/dataprotection/HISTORY.rst
  • Update VERSION to 1.6.0 in src/dataprotection/setup.py

Notes

github-actions[bot] avatar Mar 31 '25 16:03 github-actions[bot]

Hi @IannGeorges

Release Suggestions

Module: dataprotection

  • Please log updates into to src/dataprotection/HISTORY.rst
  • Update VERSION to 1.6.0 in src/dataprotection/setup.py

Notes

@evelyn-ys Is a log update for the module required for editing a command's documentation? (One parameter was removed)

IannGeorges avatar Apr 02 '25 17:04 IannGeorges

/azp run

evelyn-ys avatar Apr 03 '25 01:04 evelyn-ys

Azure Pipelines successfully started running 2 pipeline(s).

azure-pipelines[bot] avatar Apr 03 '25 01:04 azure-pipelines[bot]

@IannGeorges This PR is actually a breaking change. It's not just a doc update, it will break existing script if the script use VaultStore for the specific parameter.

Of course you need to mention the change in history notes.

If you want to release a new version to make the change live, you need to update the version as well. But I'm afraid you can't release breaking change directly. cc @ReaNAiveD for extension breaking change guidance

evelyn-ys avatar Apr 03 '25 01:04 evelyn-ys

Hi @IannGeorges , The Azure CLI team is implementing a new policy requiring a 30-day pre-announcement for all breaking changes. Please create a pull request to add a breaking change announcement according to the guidelines in the documentation. The breaking change can be released 30 days after the announcement is published.

https://github.com/Azure/azure-cli/blob/dev/doc/how_to_introduce_breaking_changes.md

ReaNAiveD avatar Apr 08 '25 13:04 ReaNAiveD