-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
️✔️Azure CLI Extensions Breaking Change Test
|
Hi @wangzelin007, |
CI |
AllyW
approved these changes
Dec 28, 2023
jsntcy
approved these changes
Dec 28, 2023
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
![image](https://private-user-images.githubusercontent.com/18628534/293162667-80eb7e4e-8ed9-4a99-aa7f-1c4f4f9b8e91.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjM0MTcxMDUsIm5iZiI6MTcyMzQxNjgwNSwicGF0aCI6Ii8xODYyODUzNC8yOTMxNjI2NjctODBlYjdlNGUtOGVkOS00YTk5LWFhN2YtMWM0ZjRmOWI4ZTkxLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA4MTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwODExVDIyNTMyNVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWE4MjQ4ODIzNjBjYzlkM2FhOTk0OWFlMWFiYmQwZTZiMDlhMjA1MjVjMmYxNGUxMDk5NmQxNTc2YTZiOGI4ZjgmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.fi8HX5gn89msNbVZzueJMCBfe97o1EmX9ZRAOQHro_E)
Otherwise the test case test_index will report an error:
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](https://private-user-images.githubusercontent.com/18628534/293164885-73c51008-61b9-4d2a-b54b-3a4d0d39fbea.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjM0MTcxMDUsIm5iZiI6MTcyMzQxNjgwNSwicGF0aCI6Ii8xODYyODUzNC8yOTMxNjQ4ODUtNzNjNTEwMDgtNjFiOS00ZDJhLWI1NGItM2E0ZDBkMzlmYmVhLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA4MTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwODExVDIyNTMyNVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTYxN2JiY2I4NmU3ZWU0MmIxNDQxYmRkM2E4YjM5OWNjOWQ4ZGMwZDY2YWEzZmIzMDFjMTEwYjVhM2RhMDA2MjUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.T_OHuTqZW3dlEDmYIykUlx5Gu_fA8NCrx0bnuvK23vo)
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](https://private-user-images.githubusercontent.com/18628534/293165843-b954bbf6-954a-4cf3-8445-7df344895911.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjM0MTcxMDUsIm5iZiI6MTcyMzQxNjgwNSwicGF0aCI6Ii8xODYyODUzNC8yOTMxNjU4NDMtYjk1NGJiZjYtOTU0YS00Y2YzLTg0NDUtN2RmMzQ0ODk1OTExLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA4MTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwODExVDIyNTMyNVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTRlNzQwOTA5ZDlhZTJjNGVkYmI3NjE0NGQzZTM3NzlmZTllODk4Mjg5ZDAzYjk3YzIxYTU3ZjQwMjg0ODNhNWImWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.RGD7An0nDbX_l6rYtWsgTSdrwqmqT7SjO28TJCFMkHM)
General Guidelines
azdev style <YOUR_EXT>
locally? (pip install azdev
required)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
.