Skip to content

[DevCenter] Add command examples#8957

Open
cxznmhdcxz wants to merge 1 commit intoAzure:mainfrom
cxznmhdcxz:command-example-devcenter
Open

[DevCenter] Add command examples#8957
cxznmhdcxz wants to merge 1 commit intoAzure:mainfrom
cxznmhdcxz:command-example-devcenter

Conversation

@cxznmhdcxz
Copy link
Copy Markdown
Member


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

Related command

az devcenter admin project-catalog create

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 July 11, 2025 07:06
@azure-client-tools-bot-prd
Copy link
Copy Markdown

azure-client-tools-bot-prd bot commented Jul 11, 2025

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

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

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
Copy Markdown
Collaborator

yonzhan commented Jul 11, 2025

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

@github-actions
Copy link
Copy Markdown
Contributor

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
Copy Markdown
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

A concise description of the purpose of the PR, followed by summarized bullets of changes

  • Adds a usage example to the create command’s docstring for az devcenter admin project-catalog.
  • Updates _create.py to include an example invocation of the command.
Comments suppressed due to low confidence (1)

src/devcenter/azext_devcenter/aaz/latest/devcenter/admin/project_catalog/_create.py:20

  • Use the standard Azure CLI docstring style for examples: replace :example: with an Examples section header (e.g., a line with Examples followed by a blank line) so the help output formats correctly.
    :example: Create a project catalog

@github-actions
Copy link
Copy Markdown
Contributor

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
Copy Markdown
Contributor

Hi @cxznmhdcxz

Release Suggestions

Module: devcenter

  • Please log updates into to src/devcenter/HISTORY.rst
  • Update VERSION to 7.0.1 in src/devcenter/setup.py

Notes

@kairu-ms
Copy link
Copy Markdown
Contributor

Please update the recording files as well

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants