Skip to content

Conversation

@cxznmhdcxz
Copy link
Member


This checklist is used to make sure that common guidelines for a pull request are followed.

Related command

General Guidelines

  • Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
  • Have you run python scripts/ci/test_index.py -q locally? (pip install wheel==0.30.0 required)
  • 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.

Copilot AI review requested due to automatic review settings June 17, 2025 03:53
@azure-client-tools-bot-prd
Copy link

azure-client-tools-bot-prd bot commented Jun 17, 2025

️✔️Azure CLI Extensions Breaking Change Test
️✔️Non Breaking Changes

@azure-client-tools-bot-prd
Copy link

Hi @cxznmhdcxz,
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.

@yonzhan
Copy link
Collaborator

yonzhan commented Jun 17, 2025

Thank you for your contribution! We will review the pull request and get back to you soon.

@github-actions
Copy link

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).
After that please run the following commands to enable git hooks:

pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>

Copy link
Contributor

Copilot AI left a 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 examples blocks 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 examples to 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 examples section for the delete commands (and other operations) following the pattern used for create. This will give users clear guidance on deleting add-ons.
helps['containerapp add-on redis delete'] = """

@github-actions
Copy link

CodeGen Tools Feedback Collection

Thank 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

@github-actions
Copy link

Hi @cxznmhdcxz

Release Suggestions

Module: containerapp

  • Please log updates into to src/containerapp/HISTORY.rst
  • Update VERSION to 1.2.0b2 in src/containerapp/setup.py

Notes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Auto-Assign Auto assign by bot ContainerApp

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants