espressif / esptool

Espressif SoC serial bootloader utility
https://docs.espressif.com/projects/esptool
GNU General Public License v2.0
5.6k stars 1.39k forks source link

ci(pypi_release): Use build --sdist argument to avoid building non-universal whl (ESPTOOL-926) #1011

Closed matthuisman closed 2 months ago

matthuisman commented 2 months ago

https://github.com/espressif/esptool/commit/eacc94a386267ad39de876f29b7bd1a6823387ae changed from using python setup.py sdist to python -m build

The latter now builds a .whl which got uploaded using twine on the 4.8.0 release (https://pypi.org/project/esptool/4.8.0/#files)

Unfortuatnely due to setup.py (https://github.com/espressif/esptool/blob/master/setup.py), the whl that is built on ubuntu uses scripts instead of entry_points This makes the whl incompatible with Windows systems and causes import error / no exe's created See https://github.com/espressif/esptool/issues/1010

This change adds --sdist argument to build which tells it not to create the whl. This allows all systems to just use the source and then do the correct setup.py behaviour

This change fixes the following bug(s):

https://github.com/espressif/esptool/issues/1010

I have tested this change with the following hardware & software combinations:

I have tested build --sdist locally in Ubuntu and then installing the results .tar.gz in both windows and ubuntu

I have run the esptool.py automated integration tests with this change and the above hardware:

NO TESTING

github-actions[bot] commented 2 months ago
Messages
:book: 🎉 Good Job! All checks are passing!

👋 Hello matthuisman, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by :no_entry_sign: dangerJS against 5de78d34f3b6437c3a6dc02edf2ebf529cba4c53

matthuisman commented 2 months ago

the other option would be to do twine upload dist/*.tar.gz instead but this felt cleaner

radimkarnis commented 2 months ago

Hi @matthuisman,

Thanks for looking into this and contributing!

LGTM. We will merge ASAP and do a bugfix release.

matthuisman commented 2 months ago

@radimkarnis thanks for quick merge

I'd suggest yanking the previous release if possible as I suspect anyone using --prefer-binary will keep getting that broken whl.