Skip to content
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

apic-extension GA release #7677

Merged
merged 25 commits into from
Jul 4, 2024
Merged

apic-extension GA release #7677

merged 25 commits into from
Jul 4, 2024

Conversation

blackchoey
Copy link
Contributor

@blackchoey blackchoey commented Jun 3, 2024


This PR include changes for apic-extension GA

  • Refactored some commands per feedback, as well as fixed some bugs. Please refer the changelog for more details.
  • Added test cases for the CLI

Related command

az apic *

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.

Copy link

azure-client-tools-bot-prd bot commented Jun 3, 2024

❌Azure CLI Extensions Breaking Change Test
❌apic-extension
rule cmd_name rule_message suggest_message
1010 - ParaPropUpdate apic api create cmd apic api create update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api create
1010 - ParaPropUpdate apic api definition create cmd apic api definition create update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api definition create
1010 - ParaPropUpdate apic api definition delete cmd apic api definition delete update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api definition delete
1010 - ParaPropUpdate apic api definition export-specification cmd apic api definition export-specification update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api definition export-specification
1007 - ParaRemove apic api definition import-specification cmd apic api definition import-specification removed parameter source_profile please add back parameter source_profile for cmd apic api definition import-specification
1008 - ParaPropAdd apic api definition import-specification cmd apic api definition import-specification update parameter format: added property required=True please remove property required=True for parameter format of cmd apic api definition import-specification
1010 - ParaPropUpdate apic api definition import-specification cmd apic api definition import-specification update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api definition import-specification
1008 - ParaPropAdd apic api definition import-specification cmd apic api definition import-specification update parameter specification: added property required=True please remove property required=True for parameter specification of cmd apic api definition import-specification
1008 - ParaPropAdd apic api definition import-specification cmd apic api definition import-specification update parameter value: added property required=True please remove property required=True for parameter value of cmd apic api definition import-specification
1010 - ParaPropUpdate apic api definition list cmd apic api definition list update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api definition list
1010 - ParaPropUpdate apic api definition show cmd apic api definition show update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api definition show
1010 - ParaPropUpdate apic api definition update cmd apic api definition update update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api definition update
1010 - ParaPropUpdate apic api delete cmd apic api delete update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api delete
1007 - ParaRemove apic api deployment create cmd apic api deployment create removed parameter state please add back parameter state for cmd apic api deployment create
1008 - ParaPropAdd apic api deployment create cmd apic api deployment create update parameter definition_id: added property required=True please remove property required=True for parameter definition_id of cmd apic api deployment create
1008 - ParaPropAdd apic api deployment create cmd apic api deployment create update parameter environment_id: added property required=True please remove property required=True for parameter environment_id of cmd apic api deployment create
1008 - ParaPropAdd apic api deployment create cmd apic api deployment create update parameter server: added property required=True please remove property required=True for parameter server of cmd apic api deployment create
1010 - ParaPropUpdate apic api deployment create cmd apic api deployment create update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api deployment create
1008 - ParaPropAdd apic api deployment create cmd apic api deployment create update parameter title: added property required=True please remove property required=True for parameter title of cmd apic api deployment create
1010 - ParaPropUpdate apic api deployment delete cmd apic api deployment delete update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api deployment delete
1010 - ParaPropUpdate apic api deployment list cmd apic api deployment list update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api deployment list
1010 - ParaPropUpdate apic api deployment show cmd apic api deployment show update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api deployment show
1007 - ParaRemove apic api deployment update cmd apic api deployment update removed parameter state please add back parameter state for cmd apic api deployment update
1010 - ParaPropUpdate apic api deployment update cmd apic api deployment update update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api deployment update
1010 - ParaPropUpdate apic api list cmd apic api list update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api list
1007 - ParaRemove apic api register cmd apic api register removed parameter environment_name please add back parameter environment_name for cmd apic api register
1010 - ParaPropUpdate apic api register cmd apic api register update parameter service_name: updated property options from ['--service', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '-s'] for parameter service_name of cmd apic api register
1010 - ParaPropUpdate apic api show cmd apic api show update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api show
1010 - ParaPropUpdate apic api update cmd apic api update update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api update
1010 - ParaPropUpdate apic api version create cmd apic api version create update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api version create
1010 - ParaPropUpdate apic api version delete cmd apic api version delete update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api version delete
1010 - ParaPropUpdate apic api version list cmd apic api version list update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api version list
1010 - ParaPropUpdate apic api version show cmd apic api version show update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api version show
1010 - ParaPropUpdate apic api version update cmd apic api version update update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic api version update
1010 - ParaPropUpdate apic environment create cmd apic environment create update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic environment create
1010 - ParaPropUpdate apic environment delete cmd apic environment delete update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic environment delete
1010 - ParaPropUpdate apic environment list cmd apic environment list update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic environment list
1010 - ParaPropUpdate apic environment show cmd apic environment show update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic environment show
1010 - ParaPropUpdate apic environment update cmd apic environment update update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic environment update
1006 - ParaAdd apic metadata create cmd apic metadata create added parameter metadata_name please remove parameter metadata_name for cmd apic metadata create
1007 - ParaRemove apic metadata create cmd apic metadata create removed parameter metadata_schema_name please add back parameter metadata_schema_name for cmd apic metadata create
1007 - ParaRemove apic metadata create cmd apic metadata create removed parameter source_profile please add back parameter source_profile for cmd apic metadata create
1010 - ParaPropUpdate apic metadata create cmd apic metadata create update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic metadata create
1006 - ParaAdd apic metadata delete cmd apic metadata delete added parameter metadata_name please remove parameter metadata_name for cmd apic metadata delete
1007 - ParaRemove apic metadata delete cmd apic metadata delete removed parameter metadata_schema_name please add back parameter metadata_schema_name for cmd apic metadata delete
1010 - ParaPropUpdate apic metadata delete cmd apic metadata delete update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic metadata delete
1010 - ParaPropUpdate apic metadata export cmd apic metadata export update parameter service_name: updated property options from ['--name', '--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--name', '--service', '--service-name', '-s'] for parameter service_name of cmd apic metadata export
1010 - ParaPropUpdate apic metadata list cmd apic metadata list update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic metadata list
1006 - ParaAdd apic metadata show cmd apic metadata show added parameter metadata_name please remove parameter metadata_name for cmd apic metadata show
1007 - ParaRemove apic metadata show cmd apic metadata show removed parameter metadata_schema_name please add back parameter metadata_schema_name for cmd apic metadata show
1010 - ParaPropUpdate apic metadata show cmd apic metadata show update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic metadata show
1006 - ParaAdd apic metadata update cmd apic metadata update added parameter metadata_name please remove parameter metadata_name for cmd apic metadata update
1007 - ParaRemove apic metadata update cmd apic metadata update removed parameter metadata_schema_name please add back parameter metadata_schema_name for cmd apic metadata update
1007 - ParaRemove apic metadata update cmd apic metadata update removed parameter source_profile please add back parameter source_profile for cmd apic metadata update
1010 - ParaPropUpdate apic metadata update cmd apic metadata update update parameter service_name: updated property options from ['--service', '--service-name', '-s'] to ['--service-name', '-n'] please change property options from ['--service-name', '-n'] to ['--service', '--service-name', '-s'] for parameter service_name of cmd apic metadata update
1012 - SubgroupRemove apic service sub group apic service removed please confirm sub group apic service removed
⚠️ 1006 - ParaAdd apic api register cmd apic api register added parameter environment_id
⚠️ 1001 - CmdAdd apic create cmd apic create added
⚠️ 1001 - CmdAdd apic delete cmd apic delete added
⚠️ 1001 - CmdAdd apic import-from-apim cmd apic import-from-apim added
⚠️ 1001 - CmdAdd apic list cmd apic list added
⚠️ 1001 - CmdAdd apic show cmd apic show added
⚠️ 1001 - CmdAdd apic update cmd apic update added

Copy link

Hi @blackchoey,
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 3, 2024

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

Copy link

github-actions bot commented Jun 3, 2024

⚠️ Release Suggestions

Module: apic-extension

  • ⚠️ Please update VERSION to be 2.0.0 in src/apic-extension/setup.py

Notes

  • Stable/preview tag is inherited from last release. If needed, please add stable/preview label to modify it.
  • Major/minor/patch/pre increment of version number is calculated by pull request code changes automatically. If needed, please add major/minor/patch/pre label to adjust it.
  • For more info about extension versioning, please refer to Extension version schema

@github-actions github-actions bot added the release-version-block Updates do not qualify release version rules. NOTE: please do not edit it manually. label Jun 3, 2024
@yonzhan yonzhan requested a review from jsntcy June 3, 2024 08:39
@yonzhan yonzhan requested a review from kairu-ms June 3, 2024 08:39
@AllyW AllyW added stable release extension module as stable and removed release-version-block Updates do not qualify release version rules. NOTE: please do not edit it manually. labels Jun 5, 2024
.github/workflows/CD.yml Outdated Show resolved Hide resolved
.github/workflows/CI.yml Outdated Show resolved Hide resolved
@blackchoey blackchoey marked this pull request as ready for review June 17, 2024 06:49
@blackchoey blackchoey changed the title apic-extension GA release [Do not merge] apic-extension GA release Jun 18, 2024
* Update HISTORY.rst - jukasper

updated changelog

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst
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

@wangzelin007
Copy link
Member

/azp run

Copy link

Azure Pipelines successfully started running 2 pipeline(s).

* fix: cannot run create command against existing resource

* style: fix style
@blackchoey
Copy link
Contributor Author

aaz PR: Azure/aaz#508

@necusjz
Copy link
Member

necusjz commented Jun 26, 2024

i saw there are a lot of "breaking changes" in #7677 (comment), are they all expected?

@blackchoey
Copy link
Contributor Author

i saw there are a lot of "breaking changes" in #7677 (comment), are they all expected?

@necusjz Yes, they're expected. We want to leverage the last chance to make some breaking changes to ensure the CLI is in the best shape. There're 3 kind of breaking changes:

  1. Align the parameter naming with other Azure CLI commands. E.g. use -n instead -s to ask for resource name.
  2. Mark some parameters as required, as they're not correctly marked before.
  3. Adjust some command signatures per feedback.

@blackchoey
Copy link
Contributor Author

/azp run

Copy link

Commenter does not have sufficient privileges for PR 7677 in repo Azure/azure-cli-extensions

@necusjz
Copy link
Member

necusjz commented Jun 26, 2024

/azp run

Copy link

Azure Pipelines successfully started running 2 pipeline(s).

@necusjz
Copy link
Member

necusjz commented Jun 28, 2024

/azp run

Copy link

Azure Pipelines successfully started running 2 pipeline(s).

@blackchoey blackchoey changed the title [Do not merge] apic-extension GA release apic-extension GA release Jul 4, 2024
@kairu-ms kairu-ms merged commit dcee6ba into Azure:main Jul 4, 2024
18 checks passed
@azclibot
Copy link
Collaborator

azclibot commented Jul 4, 2024

[Release] Update index.json for extension [ apic-extension ] : https://dev.azure.com/azclitools/release/_build/results?buildId=169884&view=results

liorstauber pushed a commit to liorstauber/azure-cli-extensions that referenced this pull request Jul 14, 2024
* build: add cicd pipeline (Azure#7)

* build: move update version logic to workflow (Azure#8)

* build: Run CI on multiple python version (Azure#38)

* build: Run CI in Python 3.8-3.11

* build: remove pull request event for CI to avoid duplicate runs

* test: add test cases for commands (Azure#40)

* fix: error when register API with long description spec (Azure#41)

* test: add test cases for optional parameters (Azure#42)

* feat!: remove file name param (Azure#43)

* fix: error not thrown when import spec with >3MB file (Azure#44)

* feat!: remove state param for deployment commands (Azure#46)

* fix: API title created by register command is not same with provided spec (Azure#47)

* feat!: redesign parameters to specify APIM instance for import-from-apim command (Azure#45)

* test: clean up legacy test cases (Azure#48)

* test: add test cases for command examples (Azure#49)

* docs: update help message per feedback (Azure#50)

* build: bump version to 1.0.0 and add changelog (Azure#51)

* fix: some parameters should be required in import-specification and deployment command (Azure#53)

* feat!: rename parameter names to align with other Azure CLI command experience (Azure#52)

* test: enable test for import-from-apim (Azure#54)

* test: fix show service test case (Azure#55)

* docs: update changelog for 1.0.0 (Azure#56)

* Update HISTORY.rst - jukasper

updated changelog

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* Update HISTORY.rst

* docs: update readme for apic-extension (#57)

* fix: cannot run create command against existing resource (Azure#58)

* fix: cannot run create command against existing resource

* style: fix style

* build: remove cicd pipeline (Azure#59)

* build: resolve review comments (Azure#60)

---------

Co-authored-by: Julia Kasper <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-cal-version stable release extension module as stable
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants