diff --git a/docs/guides/integration/dependency-bots.md b/docs/guides/integration/dependency-bots.md new file mode 100644 index 000000000000..bef4d60c6d7d --- /dev/null +++ b/docs/guides/integration/dependency-bots.md @@ -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). diff --git a/mkdocs.template.yml b/mkdocs.template.yml index e1430f6e538a..7a2086060ee1 100644 --- a/mkdocs.template.yml +++ b/mkdocs.template.yml @@ -114,6 +114,7 @@ nav: - GitHub Actions: guides/integration/github.md - Pre-commit: guides/integration/pre-commit.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