Skip to content

Commit

Permalink
Improve documentation of manually adding branch, rev, and tag (#8497)
Browse files Browse the repository at this point in the history
Closes #8490 by improving the documentation to make it more obvious how
to manually edit the `pyproject.toml` if you want to explicitly set the
branch, rev (commit), or tag.

---------

Co-authored-by: Charlie Marsh <charlie.r.marsh@gmail.com>
  • Loading branch information
cthoyt and charliermarsh authored Oct 23, 2024
1 parent 72185ba commit 109abf5
Showing 1 changed file with 41 additions and 3 deletions.
44 changes: 41 additions & 3 deletions docs/concepts/dependencies.md
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

0 comments on commit 109abf5

Please sign in to comment.