Skip to content

[docs/integration/docker] add sha pinning tip#10955

Merged
zanieb merged 2 commits intoastral-sh:mainfrom
ryan-ph:ryan-ph/guides/integration/docker/tip-pin-sha
Jan 27, 2025
Merged

[docs/integration/docker] add sha pinning tip#10955
zanieb merged 2 commits intoastral-sh:mainfrom
ryan-ph:ryan-ph/guides/integration/docker/tip-pin-sha

Conversation

@ryan-ph
Copy link
Contributor

@ryan-ph ryan-ph commented Jan 25, 2025 •
edited
Loading

Summary

As requested in #6565, this adds a tip discussing the ability to pin the image to a specific SHA digest and why it may be useful.

Test Plan

Start serving the documentation locally

uvx --with-requirements docs/requirements.txt -- mkdocs serve -f mkdocs.public.yml

Then navigate to http://127.0.0.1:8000/uv/guides/integration/docker/ to see the tool tip being rendered properly

@ryan-ph ryan-ph force-pushed the ryan-ph/guides/integration/docker/tip-pin-sha branch from 794cf62 to 731a317 Compare January 25, 2025 06:40
zanieb
zanieb reviewed Jan 25, 2025
View reviewed changes
docs/guides/integration/docker.md Outdated

!!! tip

While the examples above pin to a specific tag, it's also possible to pin a
Copy link
Member

@zanieb zanieb Jan 25, 2025

Choose a reason for hiding this comment

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

This only is usable with the Docker image, not the installer, right?

Should we move this up to below just the Dockerfile example and show how to pin to a SHA?

Copy link
Contributor Author

@ryan-ph ryan-ph Jan 27, 2025

Choose a reason for hiding this comment

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

Yea, that's good point. Moved the tooltip and added a codeblock with the sha for 0.5.24: https://github.com/astral-sh/uv/compare/731a317dfa5c2fde9b9588c7c417d63592e405fe..4c0b29ed03871fb998a79c4e1f923dd829207780

@ryan-ph
[docs/integration/docker] add sha pinning tip
4c0b29e 
As requested in astral-sh#6565, this adds a
tip discussing the ability to pin the image to a specific SHA digest and
why it may be useful.
@ryan-ph ryan-ph force-pushed the ryan-ph/guides/integration/docker/tip-pin-sha branch from 731a317 to 4c0b29e Compare January 27, 2025 06:28
@ryan-ph ryan-ph requested a review from zanieb January 27, 2025 06:29
zanieb
zanieb reviewed Jan 27, 2025
View reviewed changes
@zanieb zanieb added the documentation Improvements or additions to documentation label Jan 27, 2025
@zanieb zanieb enabled auto-merge (squash) January 27, 2025 18:28
@zanieb zanieb merged commit 90a4178 into astral-sh:main Jan 27, 2025
61 checks passed
@BrewTestBot BrewTestBot mentioned this pull request Jan 28, 2025
Merged
tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request Jan 29, 2025
@tmeijn
build(deps): update astral-sh/uv to v0.5.25
685a036 
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.5.24` -> `0.5.25` |

MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot).

**Proposed changes to behavior should be submitted there as MRs.**

---

### Release Notes

<details>
<summary>astral-sh/uv (astral-sh/uv)</summary>

### [`v0.5.25`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#0525)

[Compare Source](astral-sh/uv@0.5.24...0.5.25)

##### Enhancements

-   Allow installation of manylinux wheels on loongarch64 ([#&#8203;10927](astral-sh/uv#10927))
-   Allow optional `=` for editables in `requirements.txt` ([#&#8203;10954](astral-sh/uv#10954))
-   Add Windows aarch64 to the release binaries ([#&#8203;10885](astral-sh/uv#10885))

##### Bug fixes

-   Use spec-compliant (`128+n`) exit codes for `uv run` and `uv tool run` on Unix ([#&#8203;10781](astral-sh/uv#10781))
-   Fix best-interpreter lookups when there is an invalid interpreter in the `PATH` ([#&#8203;11030](astral-sh/uv#11030))
-   Guard against concurrent cache writes on Windows ([#&#8203;11007](astral-sh/uv#11007))
-   Prioritize package preferences with greater package versions ([#&#8203;10963](astral-sh/uv#10963))
-   Reject `--editable` flag on non-directory requirements ([#&#8203;10994](astral-sh/uv#10994))
-   Respect `--no-sources` for `uv pip install` workspace discovery ([#&#8203;11003](astral-sh/uv#11003))
-   Set `JEMALLOC_SYS_WITH_LG_PAGE=16` in ARM Docker builds ([#&#8203;10943](astral-sh/uv#10943))
-   Update `riscv64` Python downloads to allow install on `riscv64gc` ([#&#8203;10937](astral-sh/uv#10937))
-   Fix file persist retries on Windows ([#&#8203;11008](astral-sh/uv#11008))
-   Fix incorrect error message when specifying `tool.uv.sources.(package).workspace` with other options ([#&#8203;11013](astral-sh/uv#11013))
-   Improve SIGINT handling in `uv run` ([#&#8203;11009](astral-sh/uv#11009))

##### Documentation

-   Add `SECURITY` policy ([#&#8203;11035](astral-sh/uv#11035))
-   Add `Requires-Python` upper bound behavior to the docs ([#&#8203;10964](astral-sh/uv#10964))
-   Add a troubleshooting section and reproducible example guide ([#&#8203;10947](astral-sh/uv#10947))
-   Add documentation for `uv add -r` ([#&#8203;10926](astral-sh/uv#10926))
-   Amend `requires-python` rules in resolver documentation ([#&#8203;10993](astral-sh/uv#10993))
-   Reference workspaces in `--no-sources` documentation ([#&#8203;10995](astral-sh/uv#10995))
-   Update documentation for activating virtual environments in different shell ([#&#8203;11000](astral-sh/uv#11000))
-   Add Docker SHA pinning tip ([#&#8203;10955](astral-sh/uv#10955))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this MR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4xMzcuMiIsInVwZGF0ZWRJblZlciI6IjM5LjEzNy4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiXX0=-->
issokuos added a commit to issokuos/uv that referenced this pull request Jan 29, 2025
@issokuos
Merge branch 'main' into fix-8743
c165629 
* main: (22 commits)
  fix async windows file persist retries (astral-sh#11008)
  Respect `--no-sources` for `uv pip install` workspace discovery (astral-sh#11003)
  Remove unnecessary distribution clone (astral-sh#11004)
  Properly format test publish error (astral-sh#11001)
  Reject `--editable` flag on non-directory requirements (astral-sh#10994)
  Add a troubleshooting section and reproducible example guide (astral-sh#10947)
  Update documentation for activating virtual environments in different shell (astral-sh#11000)
  Improve publish test script resilience (astral-sh#10984)
  Update `compile_enumerate_no_versions ` snapshot (astral-sh#10998)
  Reference workspaces in `--no-sources` documentation (astral-sh#10995)
  [docs/integration/docker] add sha pinning tip (astral-sh#10955)
  Update name of "Build binary" job to highlight that these are the "release" binaries (astral-sh#10990)
  Use install action for cargo shear (astral-sh#10983)
  Update Rust crate rustix to v0.38.44 (astral-sh#10974)
  Update Rust crate fs-err to v3.1.0 (astral-sh#10976)
  Update pre-commit hook astral-sh/ruff-pre-commit to v0.9.3 (astral-sh#10975)
  Update Rust crate rkyv to v0.8.10 (astral-sh#10973)
  Update Rust crate jiff to v0.1.27 (astral-sh#10972)
  Update Rust crate insta to v1.42.1 (astral-sh#10971)
  Update Rust crate clap to v4.5.27 (astral-sh#10970)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zanieb zanieb zanieb approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ryan-ph @zanieb