From f96b4c78370155398a651c8db8829675d547d169 Mon Sep 17 00:00:00 2001
From: Zanie Blue <contact@zanie.dev>
Date: Wed, 28 Aug 2024 07:41:23 -0500
Subject: [PATCH] Add dependabot and renovate documentation page (#6236)

cc @mkniewallner

---------

Co-authored-by: Mathieu Kniewallner <mathieu.kniewallner@gmail.com>
---
 docs/guides/integration/dependency-bots.md | 36 ++++++++++++++++++++++
 mkdocs.template.yml                        |  1 +
 2 files changed, 37 insertions(+)
 create mode 100644 docs/guides/integration/dependency-bots.md

diff --git a/docs/guides/integration/dependency-bots.md b/docs/guides/integration/dependency-bots.md
new file mode 100644
index 000000000..bef4d60c6
--- /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 6057adf93..0dcbd6ce5 100644
--- a/mkdocs.template.yml
+++ b/mkdocs.template.yml
@@ -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