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

[packaging] Exclude also the submodules of test and docs (ESPTOOL-927) #1012

Merged
merged 1 commit into from
Sep 25, 2024

Conversation

befeleme
Copy link
Contributor

When running the wheel build of esptool 4.8.0 in Fedora, the docs/en/conf.py and test/efuse_scripts/*.py were included in the distribution.

Apparently, setuptools excludes only the first level of modules, unless specified otherwise. Following the official documentation, the Important part, adding asterisks to exclude all the found submodules does the trick
https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#finding-simple-packages

I've tested it during the Fedora RPM build and verified this change works for us.

Copy link

github-actions bot commented Sep 25, 2024

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello befeleme, 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 908d0b5

pyproject.toml Outdated Show resolved Hide resolved
@radimkarnis
Copy link
Collaborator

Also, please see the bot response above and change your commit message accordingly.

@github-actions github-actions bot changed the title [packaging] Exclude also the submodules of test and docs [packaging] Exclude also the submodules of test and docs (ESPTOOL-927) Sep 25, 2024
- "test" - installed unwanted "test/efuse_scripts/*py"
- "docs" - installed unwanted "docs/en/conf.py"
- "ci" - added "*" to be future-proof
- "flasher_stub" no longer exists
@espressif-bot espressif-bot merged commit 908d0b5 into espressif:master Sep 25, 2024
15 checks passed
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.

3 participants