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.

Sign up for GitHub

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

Jump to bottom

docs: clarify preset file name recommendations #28443

Merged
merged 2 commits into from
May 5, 2024
Merged

docs: clarify preset file name recommendations #28443

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
685f578
docs: clarify preset file name recommendations
rarkins Apr 16, 2024
7903672
Update docs/usage/config-presets.md
rarkins May 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 11 additions & 9 deletions docs/usage/config-presets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,6 @@ Read the [Key concepts, presets](./key-concepts/presets.md) page to learn more a

Shareable config presets must use the JSON or JSON5 formats, other formats are not supported.

<!-- prettier-ignore -->
!!! warning
Only use `default.json` for your presets.

<!-- prettier-ignore -->
!!! warning
We've deprecated using a `renovate.json` file for presets, as this causes issues if the repository configuration _also_ uses a `renovate.json` file.
If you're using a `renovate.json` file to share your presets, rename it to `default.json`.

<!-- prettier-ignore -->
!!! tip
Describe what your preset does in the `"description"` field.
Expand All @@ -42,6 +33,17 @@ Alternatively, Renovate can fetch preset files from an HTTP server.

You can set a Git tag (like a SemVer) to use a specific release of your shared config.

### Preset File Naming

Presets are repo-hosted, and you can have one or more presets hosted per repository.
If you omit a file name from your preset (e.g. `github>abc/foo`) then Renovate will look for a `default.json` file in the repo.
If you wish to have an alternative file name, you need to specify it (e.g. `github>abc/foo:alternative-name.json5`).
rarkins marked this conversation as resolved.
Show resolved Hide resolved

<!-- prettier-ignore -->
rarkins marked this conversation as resolved.
Show resolved Hide resolved
!!! warning
We've deprecated using a `renovate.json` file for the default _preset_ file name in a repository.
If you're using a `renovate.json` file to share your presets, rename it to `default.json`.

### GitHub

| name | example use | preset | resolves as | filename | Git tag |
Expand Down