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

Add code documentation and fix Unbound exceptions

Open Sandido opened this issue 1 year ago • 4 comments


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

Sandido avatar Oct 10 '24 13:10 Sandido

️✔️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.

yonzhan avatar Oct 10 '24 13:10 yonzhan

github-actions[bot] avatar Oct 10 '24 13:10 github-actions[bot]

@yanzhudd , please re-review and merge if possible.

Sandido avatar Nov 22 '24 21:11 Sandido

/azp run

yanzhudd avatar Nov 27 '24 02:11 yanzhudd

Azure Pipelines successfully started running 2 pipeline(s).

azure-pipelines[bot] avatar Nov 27 '24 02:11 azure-pipelines[bot]

[Release] Update index.json for extension [ vm-repair ] : https://dev.azure.com/msazure/One/_build/results?buildId=109101394&view=results

azclibot avatar Nov 27 '24 02:11 azclibot