azure-cli-extensions
azure-cli-extensions copied to clipboard
Add code documentation and fix Unbound exceptions
This PR is an example of using AI to add documentation to code and Github Copilot to find bugs to fix. This PR adds code documentation to the big custom.py file. This also fixes an Unbound exception bug in the existing_rg and copy_disk_id variables. Fixed a duplicate test name error.
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 azdevrequired) - [x] Have you run
python scripts/ci/test_index.py -qlocally? (pip install wheel==0.30.0required) - [x] My extension version conforms to the Extension version schema
For new extensions:
- [x] My extension description/summary conforms to the Extension Summary Guidelines.
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.
️✔️Azure CLI Extensions Breaking Change Test
️✔️Non Breaking Changes
Hi @Sandido, 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.
- For more info about extension versioning, please refer to Extension version schema
@yanzhudd , please re-review and merge if possible.
/azp run
Azure Pipelines successfully started running 2 pipeline(s).
[Release] Update index.json for extension [ vm-repair ] : https://dev.azure.com/msazure/One/_build/results?buildId=109101394&view=results