-
Notifications
You must be signed in to change notification settings - Fork 1.5k
[amg] Add command examples #8823
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
️✔️Azure CLI Extensions Breaking Change Test
|
|
Hi @cxznmhdcxz, |
|
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>
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds usage examples to help documentation for several Grafana-related Azure CLI commands.
- Introduces an
examplessection for thegrafana folder createcommand - Adds an
examplessection for thegrafana api-key createcommand - Includes an
examplessection for thegrafana integrations monitor addcommand
Comments suppressed due to low confidence (3)
src/amg/azext_amg/_help.py:324
- The
examples:line is indented inconsistently withtype:andshort-summary:; align it to the same indentation level (6 spaces) to ensure proper help rendering.
examples:
src/amg/azext_amg/_help.py:377
- The
examples:section here should match the indentation of the surrounding help keys (6 spaces) for consistent formatting.
examples:
src/amg/azext_amg/_help.py:467
- Please adjust the indentation of this
examples:line to align with the other help entries (6 spaces) so the CLI help output formats correctly.
examples:
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 |
|
Hi @cxznmhdcxz Release SuggestionsModule: amg
Notes
|
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.