Skip to content

Commit

Permalink
Add dependabot and renovate documentation page (#6236)
Browse files Browse the repository at this point in the history
cc @mkniewallner

---------

Co-authored-by: Mathieu Kniewallner <mathieu.kniewallner@gmail.com>
  • Loading branch information
zanieb and mkniewallner committed Aug 28, 2024
1 parent 53ef633 commit f96b4c7
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
36 changes: 36 additions & 0 deletions docs/guides/integration/dependency-bots.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Dependency bots

## Renovate

uv is supported by [Renovate](https://github.com/renovatebot/renovate).

Renovate uses the presence of a `uv.lock` file to determine that uv is used for managing
dependencies, and will suggest upgrades to
[project dependencies](../../concepts/dependencies.md#project-dependencies),
[optional dependencies](../../concepts/dependencies.md#optional-dependencies) and
[development dependencies](../../concepts/dependencies.md#development-dependencies). Renovate will
update both the `pyproject.toml` and `uv.lock` files.

The lockfile can also be refreshed on a regular basis (for instance to update transitive
dependencies) by enabling the
[`lockFileMaintenance`](https://docs.renovatebot.com/configuration-options/#lockfilemaintenance)
option:

```json5 title="renovate.json5"
{
$schema: "https://docs.renovatebot.com/renovate-schema.json",
lockFileMaintenance: {
enabled: true,
},
}
```

!!! note

`uv pip compile` outputs such as `requirements.txt` are not yet supported by Renovate.
Progress can be tracked at [renovatebot/renovate#30909](https://github.com/renovatebot/renovate/issues/30909).

## Dependabot

Support for uv is not yet available. Progress can be tracked at
[dependabot/dependabot-core#10039](https://github.com/dependabot/dependabot-core/issues/10039).
1 change: 1 addition & 0 deletions mkdocs.template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ nav:
- Pre-commit: guides/integration/pre-commit.md
- FastAPI: guides/integration/fastapi.md
- Alternative indexes: guides/integration/alternative-indexes.md
- Dependency bots: guides/integration/dependency-bots.md
- The pip interface:
- pip/index.md
- Using environments: pip/environments.md
Expand Down

0 comments on commit f96b4c7

Please sign in to comment.