Mention cooldown and tweak inline script metadata in dependency bots documentation (#18230)
## Summary Update [Dependency bots](https://docs.astral.sh/uv/guides/integration/dependency-bots/) documentation to mention how to set up dependency cooldown on Renovate/Dependabot, to match what could be set in `exclude-newer`. Also: - updating configuration example for inline script metadata, as per [this documentation](https://docs.renovatebot.com/configuration-options/#managerfilepatterns), `fileMatch` is deprecated, and `managerFilePatterns` should be used instead -- the option supports both globs and regexes, so I've updated the examples to highlight that globs can be used - adding a note about Renovate not supporting lock files for inline script metadata yet ## Test Plan Rendered the documentation locally. For all Renovate changes, tested locally using: ```shell pnpx renovate --platform local ``` For Dependabot, I did not test it as I don't use it, so I've followed the [documentation](https://docs.github.com/en/code-security/reference/supply-chain-security/dependabot-options-reference#cooldown-).
This commit is contained in:
committed by
GitHub
parent
198813cc4d
commit
fa116eff05
@@ -40,24 +40,58 @@ option:
|
||||
### Inline script metadata
|
||||
|
||||
Renovate supports updating dependencies defined using
|
||||
[script inline metadata](../scripts.md/#declaring-script-dependencies).
|
||||
[inline script metadata](../scripts.md/#declaring-script-dependencies).
|
||||
|
||||
Since it cannot automatically detect which Python files use script inline metadata, their locations
|
||||
Since it cannot automatically detect which Python files use inline script metadata, their locations
|
||||
need to be explicitly defined using
|
||||
[`fileMatch`](https://docs.renovatebot.com/configuration-options/#filematch), like so:
|
||||
[`managerFilePatterns`](https://docs.renovatebot.com/configuration-options/#managerfilepatterns),
|
||||
like so:
|
||||
|
||||
```jsx title="renovate.json5"
|
||||
{
|
||||
$schema: "https://docs.renovatebot.com/renovate-schema.json",
|
||||
pep723: {
|
||||
fileMatch: [
|
||||
"scripts/generate_docs\\.py",
|
||||
"scripts/run_server\\.py",
|
||||
managerFilePatterns: [
|
||||
"docs/build.py",
|
||||
"scripts/**/*.py",
|
||||
],
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
!!! note
|
||||
|
||||
Renovate does not yet support updating the lock file associated to the
|
||||
script (https://github.com/renovatebot/renovate/issues/33591), so if you rely on this feature
|
||||
for a script, the lock file will need to be manually updated.
|
||||
|
||||
### Dependency cooldown
|
||||
|
||||
If you use [`exclude-newer`](../../reference/settings.md#exclude-newer) option, it is recommended to
|
||||
also set the equivalent
|
||||
[`minimumReleaseAge`](https://docs.renovatebot.com/configuration-options/#minimumreleaseage) option
|
||||
in Renovate, to avoid ending up with pull requests where uv would not be able to lock the
|
||||
dependencies.
|
||||
|
||||
For instance, if you've set `exclude-newer` to `1 week`, you can set:
|
||||
|
||||
```jsx title="renovate.json5"
|
||||
{
|
||||
$schema: "https://docs.renovatebot.com/renovate-schema.json",
|
||||
|
||||
// Enable only for PyPI.
|
||||
packageRules: [
|
||||
{
|
||||
matchDatasources: ["pypi"],
|
||||
minimumReleaseAge: "1 week",
|
||||
},
|
||||
],
|
||||
|
||||
// Or enable for every ecosystem.
|
||||
minimumReleaseAge: "1 week",
|
||||
}
|
||||
```
|
||||
|
||||
## Dependabot
|
||||
|
||||
Dependabot has announced support for uv, but there are some use cases that are not yet working. See
|
||||
@@ -75,3 +109,25 @@ updates:
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
```
|
||||
|
||||
### Dependency cooldown
|
||||
|
||||
If you use [`exclude-newer`](../../reference/settings.md#exclude-newer) option, it is recommended to
|
||||
also set the equivalent
|
||||
[`cooldown`](https://docs.github.com/en/code-security/reference/supply-chain-security/dependabot-options-reference#cooldown-)
|
||||
option in Dependabot, to avoid ending up with pull requests where uv would not be able to lock the
|
||||
dependencies.
|
||||
|
||||
For instance, if you've set `exclude-newer` to `1 week`, you can set:
|
||||
|
||||
```yaml title="dependabot.yml"
|
||||
version: 2
|
||||
|
||||
updates:
|
||||
- package-ecosystem: "uv"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
cooldown:
|
||||
default-days: 7
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user