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

{CI} Add build wheel check and extension name check #7131

Merged
merged 9 commits into from
Dec 28, 2023

Conversation

wangzelin007
Copy link
Member

@wangzelin007 wangzelin007 commented Dec 28, 2023


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

Related command

The name in setup.py should be the same as the extension dir name.
Otherwise the test case test_index will report an error:
image

At the same time, we should restrict setup.py to not allow the use of underscores, otherwise the version information of the build package cannot be obtained after user install the extension.
image

Only if the name contains an underscore, the version information cannot be displayed. This problem only appeared recently, and only packages built on the ci environment have problems, which cannot be reproduced in the local environment. The root cause has not yet been found.

Add build wheel check and extension name check to avoid the same error:
image

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)

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 Dec 28, 2023

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

Copy link

Hi @wangzelin007,
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 Dec 28, 2023

CI

@wangzelin007 wangzelin007 marked this pull request as ready for review December 28, 2023 08:12
@wangzelin007 wangzelin007 merged commit f9b715b into Azure:main Dec 28, 2023
15 checks passed
ddouglas-msft pushed a commit to ddouglas-msft/azure-cli-extensions that referenced this pull request Jan 10, 2024
* Update azdev_linter_style.py

* Update setup.py

* Update azdev_linter_style.py

* Update azdev_linter_style.py

* Update azdev_linter_style.py

* Update azdev_linter_style.py

* Update setup.py

* Update azdev_linter_style.py
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 CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants