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

Pin python libraries #23

Merged
merged 1 commit into from
Jan 11, 2024
Merged

Pin python libraries #23

merged 1 commit into from
Jan 11, 2024

Conversation

Bckempa
Copy link
Contributor

@Bckempa Bckempa commented Dec 18, 2023

Use pinned requirements.txt and an additional constraints.txt file to ensure pip constructs a viable build environment. The upstream version (see [1]) partially depends on the distribution repositories for versioning via packages like python3-doc8 but I went though and pinned everything in the pip files instead to create a single source of truth independent of system packages.

Based on [1] by @clalancette upstream in ros2/ros2_documentation

Fixes #21

[1] ros2/ros2_documentation@e43347d

@Bckempa Bckempa added this to the humble-2024.01.0 milestone Dec 18, 2023
@Bckempa
Copy link
Contributor Author

Bckempa commented Dec 18, 2023

I've tested this by building the doc site with both the repo's own dockerfile and an externally managed virtualenv using Python 3.10.13 on Ubuntu 22.04. It appears to fix both the library version resolution issue as well as the Sphinx runtime exception described in #21

@ivanperez-keera
Copy link
Contributor

ivanperez-keera commented Dec 18, 2023

Thanks @Bckempa . I'll review this tomorrow in detail.

A couple of changes that I can already propose are:

  • Squash the commits (the second really belongs with the first in this case). If you want to split them, then I'd say that the requirements.txt goes in one commit (maybe with the constraints.txt), and the changes to the CI job go in another. But in this case, I'd accept a squash too.

  • Reference the issue number you're addressing at the end of the summary line of the commit message, as in:

Pin python libraries (#21).

<rest of the message>

@Bckempa Bckempa force-pushed the bckempa/pin-python-libs branch from bf219ca to 7de6e47 Compare December 18, 2023 05:50
Use pinned `requirements.txt` and an additional `constraints.txt` file
to ensure pip constructs a viable build environment. The upstream
version (see [1]) partially depends on the distribution repositories
for versioning via packages like `python3-doc8` but I went though and
pinned everything in the `pip` files instead to create a single source
of truth independent of system packages.

Based on [1] by @clalancette upstream in `ros2/ros2_documentation`

[1] ros2/ros2_documentation@e43347d
@Bckempa Bckempa force-pushed the bckempa/pin-python-libs branch from 7de6e47 to b1d09a9 Compare December 18, 2023 05:51
@Bckempa
Copy link
Contributor Author

Bckempa commented Dec 18, 2023

Thanks for the reminder, should be fixed.

@Bckempa Bckempa self-assigned this Dec 28, 2023
@ivanperez-keera
Copy link
Contributor

I can confirm that this allows me to build the image correctly.

@ivanperez-keera ivanperez-keera merged commit be70179 into rolling Jan 11, 2024
2 checks passed
@ivanperez-keera ivanperez-keera deleted the bckempa/pin-python-libs branch January 11, 2024 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Failure to compile docs using docker due to version of docutils installed
2 participants