Skip to content

Docs: Spell out the names of the Docker images for easier copy-paste #7706

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.

Sign up for GitHub

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

Merged
zanieb merged 1 commit into from
Sep 26, 2024
Merged

Docs: Spell out the names of the Docker images for easier copy-paste #7706

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 28 additions & 25 deletions docs/guides/integration/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,43 +20,46 @@ $ docker run ghcr.io/astral-sh/uv --help

uv provides a distroless Docker image including the `uv` binary. The following tags are published:

- `uv:latest`
- `uv:{major}.{minor}.{patch}`, e.g., `uv:0.4.16`
- `uv:{major}.{minor}`, e.g., `uv:0.4` (the latest patch version)
- `ghcr.io/astral-sh/uv:latest`
- `ghcr.io/astral-sh/uv:{major}.{minor}.{patch}`, e.g., `ghcr.io/astral-sh/uv:0.4.16`
- `ghcr.io/astral-sh/uv:{major}.{minor}`, e.g., `ghcr.io/astral-sh/uv:0.4` (the latest patch
version)

In addition, uv publishes the following images:

<!-- prettier-ignore -->
Copy link
Copy Markdown
Member

@zanieb zanieb Sep 26, 2024

Choose a reason for hiding this comment

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

Yes, we need to keep this or prettier breaks the rendering of the list which requires an indent of four.

Copy link
Copy Markdown
Contributor Author

@akx akx Sep 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Okay, I'll re-add it. What requires an indent of four for nested lists, though, out of curiosity? (PyCharm's built-in Markdown renderer is fine with two.)

Copy link
Copy Markdown
Member

@zanieb zanieb Sep 26, 2024

Choose a reason for hiding this comment

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

mkdocs, I guess. #5819

- Based on `alpine:3.20`:
- `uv:alpine`
- `uv:alpine3.20`
- `ghcr.io/astral-sh/uv:alpine`
- `ghcr.io/astral-sh/uv:alpine3.20`
- Based on `debian:bookworm-slim`:
- `uv:debian-slim`
- `uv:bookworm-slim`
- `ghcr.io/astral-sh/uv:debian-slim`
- `ghcr.io/astral-sh/uv:bookworm-slim`
- Based on `buildpack-deps:bookworm`:
- `uv:debian`
- `uv:bookworm`
- `ghcr.io/astral-sh/uv:debian`
- `ghcr.io/astral-sh/uv:bookworm`
- Based on `python3.x-alpine`:
- `uv:python3.12-alpine`
- `uv:python3.11-alpine`
- `uv:python3.10-alpine`
- `uv:python3.9-alpine`
- `uv:python3.8-alpine`
- `ghcr.io/astral-sh/uv:python3.12-alpine`
- `ghcr.io/astral-sh/uv:python3.11-alpine`
- `ghcr.io/astral-sh/uv:python3.10-alpine`
- `ghcr.io/astral-sh/uv:python3.9-alpine`
- `ghcr.io/astral-sh/uv:python3.8-alpine`
- Based on `python3.x-bookworm`:
- `uv:python3.12-bookworm`
- `uv:python3.11-bookworm`
- `uv:python3.10-bookworm`
- `uv:python3.9-bookworm`
- `uv:python3.8-bookworm`
- `ghcr.io/astral-sh/uv:python3.12-bookworm`
- `ghcr.io/astral-sh/uv:python3.11-bookworm`
- `ghcr.io/astral-sh/uv:python3.10-bookworm`
- `ghcr.io/astral-sh/uv:python3.9-bookworm`
- `ghcr.io/astral-sh/uv:python3.8-bookworm`
- Based on `python3.x-slim-bookworm`:
- `uv:python3.12-bookworm-slim`
- `uv:python3.11-bookworm-slim`
- `uv:python3.10-bookworm-slim`
- `uv:python3.9-bookworm-slim`
- `uv:python3.8-bookworm-slim`
- `ghcr.io/astral-sh/uv:python3.12-bookworm-slim`
- `ghcr.io/astral-sh/uv:python3.11-bookworm-slim`
- `ghcr.io/astral-sh/uv:python3.10-bookworm-slim`
- `ghcr.io/astral-sh/uv:python3.9-bookworm-slim`
- `ghcr.io/astral-sh/uv:python3.8-bookworm-slim`
<!-- prettier-ignore-end -->

As with the distroless image, each image is published with uv version tags as
`uv:{major}.{minor}.{patch}-{base}` and `uv:{major}.{minor}-{base}`, e.g., `uv:0.4.16-alpine`.
`ghcr.io/astral-sh/uv:{major}.{minor}.{patch}-{base}` and
`ghcr.io/astral-sh/uv:{major}.{minor}-{base}`, e.g., `ghcr.io/astral-sh/uv:0.4.16-alpine`.

For more details, see the [GitHub Container](https://github.com/astral-sh/uv/pkgs/container/uv)
page.
Expand Down