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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump Docker images use for documentation to Alpine 3.20 #10695

Merged
merged 4 commits into from
Jun 5, 2024

Conversation

jnoordsij
Copy link
Contributor

What does this PR do?

Update both Docker images for docs to use the latest Alpine version (3.19).
Given that in Alpine 3.19 Python's package directory is marked as externally managed, the docs image was updated to use a Python venv. The requirements file was updated accordingly, to no longer include unrelated system packages and bump a few (nested) dependencies. Dependency bumps were kept to a minimum, but updating them further might definitely be a good follow-up.

Motivation

While trying to debug docs failure job for #10664, I noticed:

  • the image versions were using different versions, not being the latest
  • dependencies for mkdocs were not installable locally using requirements.txt

This PR should solve both issues (albeit still not explaining the job failure 馃槗). It should also make Python/pip package installation more consistent, given that system installed packages are no longer used.

More

  • Added/updated tests
  • Added/updated documentation

Additional Notes

Also threw in a typo fix I still had in my diffs because I figured a separate PR would be too much of a thing for this.

@traefiker traefiker added this to the 2.11 milestone May 5, 2024
@ldez ldez changed the title Bump docs Docker images to Alpine 3.19 Bump Docker images use for documentation to Alpine 3.19 May 5, 2024
@ldez
Copy link
Member

ldez commented May 5, 2024

The requirements.txt should contain the exhaustive list of dependencies.
We encounter several time dependency problems related to breaking changes, so all the dependencies should be locked.

@jnoordsij
Copy link
Contributor Author

The requirements.txt should contain the exhaustive list of dependencies.

It does still. I assume the previous version included system installed packages that came with installing pip and/or python3-dev; I've now generated it to have all direct dependencies listed on top and then pip freeze-ing after installing those.

@jnoordsij jnoordsij changed the title Bump Docker images use for documentation to Alpine 3.19 Bump Docker images use for documentation to Alpine 3.20 May 23, 2024
@jnoordsij
Copy link
Contributor Author

Update: bumped to Alpine 3.20, which was released yesterday

Copy link
Member

@mmatur mmatur left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@kevinpollet kevinpollet left a comment

Choose a reason for hiding this comment

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

Thanks 馃憤

Copy link
Member

@rtribotte rtribotte left a comment

Choose a reason for hiding this comment

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

Thanks!

@traefiker traefiker merged commit b368e71 into traefik:v2.11 Jun 5, 2024
22 checks passed
@jnoordsij jnoordsij deleted the alpine3.19-bump branch June 5, 2024 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants