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(pypi_release): Use build --sdist argument to avoid building non-universal whl (ESPTOOL-926) #1011

Merged
merged 1 commit into from
Sep 23, 2024

Conversation

matthuisman
Copy link
Contributor

@matthuisman matthuisman commented Sep 23, 2024

eacc94a 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 #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):

#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

Copy link

github-actions bot commented Sep 23, 2024

Messages
📖 🎉 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 🚫 dangerJS against 5de78d3

@matthuisman matthuisman changed the title Only upload .tar.gz to pypi ci(pypi_release): Use build --sdist argument to not build non-universal whl Sep 23, 2024
@matthuisman matthuisman changed the title ci(pypi_release): Use build --sdist argument to not build non-universal whl ci(pypi_release): Use build --sdist argument to avoid building non-universal whl Sep 23, 2024
@matthuisman
Copy link
Contributor Author

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

@github-actions github-actions bot changed the title ci(pypi_release): Use build --sdist argument to avoid building non-universal whl ci(pypi_release): Use build --sdist argument to avoid building non-universal whl (ESPTOOL-926) Sep 23, 2024
@radimkarnis
Copy link
Collaborator

Hi @matthuisman,

Thanks for looking into this and contributing!

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

@espressif-bot espressif-bot merged commit 5de78d3 into espressif:master Sep 23, 2024
18 checks passed
@matthuisman
Copy link
Contributor Author

@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.

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.8.0] Breaks esptool import due to esptool.py in Scripts instead of esptool.exe (ESPTOOL-924)
3 participants