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

README.rst: Update installing from source section #738

Merged
merged 1 commit into from
Sep 20, 2024

Conversation

pdgendt
Copy link
Collaborator

@pdgendt pdgendt commented Sep 19, 2024

This section was outdated as we have moved to pyproject.toml.

This section was outdated as we have moved to pyproject.toml.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
@pdgendt pdgendt added this to the v1.3.0 milestone Sep 19, 2024
@marc-hb
Copy link
Collaborator

marc-hb commented Sep 19, 2024

According to c399c01, the new way still creates a wheel, but it does not require the "wheel" package anymore, correct? Packaging noob here sorry.

The same commit refers to a pyproject-build command but this commit uses python -m build instead, can you explain?

Despite the recent efforts, it feels like we still have a bit of copy/paste/diverge between the README.rst and MAINTAINERS.rst files... maybe it's by design but I'd like to understand why.


# Windows
py -3 setup.py bdist_wheel
pip3 install --upgrade build
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I said before in #715 (comment), I'm not a fan of using the random version of the day. This is not good for reproducibility.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is done as described by python itself.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you mean https://packaging.python.org/en/latest/tutorials/packaging-projects/#generating-distribution-archives?

Any author of any package in any language will always tell you to run "the latest" because they're not interested in reports of bugs that they have already fixed. They're only interested in reports of new bugs. That bias is not necessarily aligned with packaging and release goals - notably build reproducibility.

Somewhat related and on-going discussion in #737

Copy link
Collaborator

@marc-hb marc-hb Sep 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I built and inspected west-1.2.99-py3-none-any.whl on very different Operating Systems: Ubuntu 22, Arch Linux and macOS and I have very good build reproducibility news. Ubuntu 22 shipped with old python-build version 0.7.0 while the other two had the latest 1.2.2 version. Yet the content of the wheel packages were identical (except for the expected .zip metadata differences). So python-build does not seem to inject any timestamp or version-dependent metadata in the package, which means its version does not seem to affect build reproducibility.

@pdgendt
Copy link
Collaborator Author

pdgendt commented Sep 20, 2024

According to c399c01, the new way still creates a wheel, but it does not require the "wheel" package anymore, correct? Packaging noob here sorry.

It does create a wheel indeed. Not an expert, just trying to follow documentation.

The same commit refers to a pyproject-build command but this commit uses python -m build instead, can you explain?

Again, trying to update steps as per the python documentation, and python -m build seems to be preferred.

Despite the recent efforts, it feels like we still have a bit of copy/paste/diverge between the README.rst and MAINTAINERS.rst files... maybe it's by design but I'd like to understand why.

I updated the maintainers file in the release update to also use the same build command. Do you feel that other places are diverged?

@marc-hb marc-hb merged commit 08d0329 into zephyrproject-rtos:main Sep 20, 2024
9 checks passed
@pdgendt pdgendt deleted the update-readme branch September 20, 2024 22:34
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.

2 participants