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.

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

Add dependabot and renovate documentation page #6236

Merged
merged 5 commits into from
Aug 28, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
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 on also be refreshed on a regular basis (for instance to update transitive
zanieb marked this conversation as resolved.
Show resolved Hide resolved
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.
zanieb marked this conversation as resolved.
Show resolved Hide resolved
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
zanieb marked this conversation as resolved.
Show resolved Hide resolved
[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 @@ -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
Expand Down
Loading