-
Notifications
You must be signed in to change notification settings - Fork 1.5k
[Containerapp] Add command examples #8868
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
base: main
Are you sure you want to change the base?
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 example usages for various az containerapp add-on ... create commands to improve documentation clarity.
- Added
examplesblocks for Redis, Postgres, Kafka, MariaDB, Qdrant, Weaviate, and Milvus create commands. - Ensured each example shows the full command syntax with resource group, add-on name, and environment parameters.
Comments suppressed due to low confidence (2)
src/containerapp/azext_containerapp/_help.py:337
-
Indent the list items under
examplesto align with the Azure CLI help format. For example:examples:
- name: Create a Redis add-on.
text: |
az containerapp add-on redis create -g MyResourceGroup --name MyRedisAddOn --environment MyContainerappEnv
This ensures the examples render correctly in the help output.
examples:
src/containerapp/azext_containerapp/_help.py:397
- To keep the help docs consistent, consider adding an
examplessection for thedeletecommands (and other operations) following the pattern used forcreate. This will give users clear guidance on deleting add-ons.
helps['containerapp add-on redis delete'] = """
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: containerapp
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.