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.

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

Improve documentation of manually adding branch, rev, and tag #8497

Merged
merged 6 commits into from
Oct 23, 2024
Merged

Improve documentation of manually adding branch, rev, and tag #8497

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a2d8d79
Improve documentation of manually adding branch, rev, and tag to pypr…
cthoyt Oct 23, 2024
3f37f14
Fix spacing
cthoyt Oct 23, 2024
f907402
Fix typo
cthoyt Oct 23, 2024
337d242
Update dependencies.md
cthoyt Oct 23, 2024
d0f1bc6
Update dependencies.md
cthoyt Oct 23, 2024
86f2091
Tweaks
charliermarsh Oct 23, 2024
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
44 changes: 41 additions & 3 deletions docs/concepts/dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,16 +136,54 @@ dependencies = [
httpx = { git = "https://github.com/encode/httpx" }
```

A revision, tag, or branch may also be included:
A revision (i.e., commit), tag, or branch may also be included:

```console
$ uv add git+https://github.com/encode/httpx --tag 0.27.0
$ uv add git+https://github.com/encode/httpx --branch main
$ uv add git+https://github.com/encode/httpx --rev 326b943
$ uv add git+https://github.com/encode/httpx --rev 326b9431c761e1ef1e00b9f760d1f654c8db48c6
```

Git dependencies can also be manually added or edited in the `pyproject.toml` with the
`{ git = <url> }` syntax. A target revision may be specified with one of: `rev`, `tag`, or `branch`.
`{ git = <url> }` syntax. A target revision may be specified with one of: `rev` (i.e., commit),
`tag`, or `branch`.

=== "tag"

```toml title="pyproject.toml"
[project]
dependencies = [
"httpx",
]

[tool.uv.sources]
httpx = { git = "https://github.com/encode/httpx", tag = "0.27.0" }
```

=== "branch"

```toml title="pyproject.toml"
[project]
dependencies = [
"httpx",
]

[tool.uv.sources]
httpx = { git = "https://github.com/encode/httpx", branch = "main" }
```

=== "rev"

```toml title="pyproject.toml"
[project]
dependencies = [
"httpx",
]

[tool.uv.sources]
httpx = { git = "https://github.com/encode/httpx", rev = "326b9431c761e1ef1e00b9f760d1f654c8db48c6" }
```

A `subdirectory` may be specified if the package isn't in the repository root.

### URL
Expand Down
Loading