{dataprotection} Minor documentation update#9644
Conversation
️✔️Azure CLI Extensions Breaking Change Test
|
|
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>
|
CodeGen Tools Feedback CollectionThank 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 |
There was a problem hiding this comment.
Pull request overview
Updates the dataprotection Azure CLI extension documentation to clarify intended usage of generated JSON payloads from initialization commands, and bumps the extension version to publish the doc change.
Changes:
- Bump extension version from
1.8.0to1.8.1. - Extend help text for
initialize-backupconfigandinitialize-restoreconfigto clarify the generated JSON is intended for use with other CLI commands. - Add a
1.8.1entry toHISTORY.rstdocumenting the help-text clarification.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/dataprotection/setup.py | Version bump to 1.8.1 for releasing the documentation update. |
| src/dataprotection/azext_dataprotection/manual/_help.py | Clarifies CLI help summaries for the two initialize-*config commands. |
| src/dataprotection/HISTORY.rst | Adds release notes entry for 1.8.1 describing the documentation change. |
|
|
@calvinhzy are there any comments I should resolve on this PR? |
|
[Release] Update index.json for extension [ dataprotection-1.8.1 ] : https://dev.azure.com/msazure/One/_build/results?buildId=155652949&view=results |
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
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.