Skip to content

Commit a4eef2f

Browse files
committed
document org renovate presets
1 parent 39a5e9b commit a4eef2f

1 file changed

Lines changed: 17 additions & 5 deletions

File tree

src/infra/docs/renovate.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,23 @@ Here are the differences between the two apps:
4646

4747
### 2. Configure Renovate
4848

49-
Create a `.github/renovate.json5` file.
50-
Other file formats and locations are also supported, see the [Renovate documentation](https://docs.renovatebot.com/configuration-options/).
51-
52-
See the existing configuration files in the Rust organization for examples:
53-
[GitHub code search for `renovate.json` paths](https://github.com/search?q=org%3Arust-lang+path%3Arenovate.json&type=code).
49+
Create a `.github/renovate.json5` file with the following content:
50+
51+
```json5
52+
{
53+
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
54+
"extends": ["github>rust-lang/renovate"]
55+
}
56+
```
57+
58+
Note:
59+
- If you don't like our default configuration, have a look at [rust-lang/renovate](https://github.com/rust-lang/renovate)
60+
to learn how to customize our org presets.
61+
- If you don't like any of our org presets, you can also use your own configuration that don't extend any of our presets.
62+
If you have ideas on how to improve our org presets, PRs are welcome!
63+
- Other file formats and locations are also supported, see the [Renovate documentation](https://docs.renovatebot.com/configuration-options/).
64+
- You can take inspiration from other configuration files in the Rust organization with a
65+
[GitHub code search for `renovate.json` paths](https://github.com/search?q=org%3Arust-lang+path%3Arenovate.json&type=code).
5466

5567
### 3. Ensure Renovate is working
5668

0 commit comments

Comments
 (0)