Skip to content

Commit 04b8e0a

Browse files
committed
docs: Add Default preset section to README.md with configuration and usage details
1 parent 7b9078e commit 04b8e0a

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,50 @@ This configuration ensures that Minestom dependencies are correctly versioned ac
8888
}
8989
```
9090

91+
### Default Preset
92+
93+
The Default preset provides a general-purpose configuration for Renovate with common settings and best practices.
94+
95+
**Configuration:**
96+
97+
```json
98+
{
99+
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
100+
"extends": [
101+
"config:recommended",
102+
":automergePatch",
103+
":assignee({{arg0}})",
104+
":timezone(Europe/Berlin)",
105+
"schedule:officeHours",
106+
"schedule:automergeOfficeHours",
107+
":semanticCommits",
108+
":label(renovate)",
109+
":enableVulnerabilityAlerts"
110+
],
111+
"rebaseWhen": "conflicted"
112+
}
113+
```
114+
115+
This configuration includes:
116+
- Renovate's recommended configuration
117+
- Automatic merging of patch updates
118+
- PR assignment to a specified user (automatically set using the arg0 parameter)
119+
- European timezone and office hours scheduling
120+
- Semantic commit messages
121+
- Renovate labeling
122+
- Vulnerability alerts
123+
- Conflict-only rebasing strategy
124+
125+
**Usage:**
126+
127+
```json
128+
{
129+
"extends": ["github>onelitefeathernet/renovate:default(onelitefeathernet/maintainers)"]
130+
}
131+
```
132+
133+
In this example, `onelitefeathernet/maintainers` is passed as the `arg0` parameter, which will be used to automatically set the assignee for all Renovate pull requests. You can replace it with your own username, team name, or any valid GitHub user/team identifier that should be assigned to the PRs.
134+
91135
### Additional Presets
92136

93137
More presets will be added in the future to support other package ecosystems and versioning schemes.

0 commit comments

Comments
 (0)