/
default.ts
609 lines (608 loc) · 15.9 KB
/
default.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
import type { Preset } from '../types';
/* eslint sort-keys: ["error", "asc", {caseSensitive: false, natural: true}] */
export const presets: Record<string, Preset> = {
approveMajorUpdates: {
description: 'Require Dependency Dashboard approval for `major` updates.',
packageRules: [
{
dependencyDashboardApproval: true,
matchUpdateTypes: ['major'],
},
],
},
assignAndReview: {
description: 'Set `{{arg0}}` as assignee and reviewer of PRs.',
extends: [':assignee({{arg0}})', ':reviewer({{arg0}})'],
},
assignee: {
assignees: ['{{arg0}}'],
description: 'Assign PRs to `{{arg0}}`.',
},
automergeAll: {
automerge: true,
description:
'Automerge all upgrades (including `major`) if they pass tests.',
},
automergeBranch: {
automergeType: 'branch',
description:
'If automerging, push the new commit directly to the base branch (no PR).',
},
automergeDigest: {
description: 'Automerge `digest` upgrades if they pass tests.',
digest: {
automerge: true,
},
},
automergeDisabled: {
automerge: false,
description:
'Disable automerging feature - wait for humans to merge all PRs.',
},
automergeLinters: {
description: 'Update lint packages automatically if tests pass.',
packageRules: [
{
automerge: true,
extends: ['packages:linters'],
},
],
},
automergeMajor: {
automerge: true,
description:
'Automerge all upgrades (including `major`) if they pass tests.',
},
automergeMinor: {
description: 'Automerge `patch` and `minor` upgrades if they pass tests.',
lockFileMaintenance: {
automerge: true,
},
minor: {
automerge: true,
},
patch: {
automerge: true,
},
pin: {
automerge: true,
},
},
automergePatch: {
description: 'Automerge `patch` upgrades if they pass tests.',
lockFileMaintenance: {
automerge: true,
},
patch: {
automerge: true,
},
pin: {
automerge: true,
},
separateMinorPatch: true,
},
automergePr: {
automergeType: 'pr',
description: 'Raise a PR first before any automerging.',
},
automergeRequireAllStatusChecks: {
description: 'Require all status checks to pass before any automerging.',
ignoreTests: false,
},
automergeStableNonMajor: {
description:
'Automerge non-major upgrades for semver stable packages if they pass tests.',
packageRules: [
{
automerge: true,
matchCurrentVersion: '>= 1.0.0',
matchUpdateTypes: ['minor', 'patch'],
},
],
},
automergeTesters: {
description: 'Update testing packages automatically if tests pass.',
packageRules: [
{
automerge: true,
extends: ['packages:test'],
},
],
},
automergeTypes: {
description: 'Update `@types/*` packages automatically if tests pass.',
packageRules: [
{
automerge: true,
matchPackagePrefixes: ['@types/'],
},
],
},
combinePatchMinorReleases: {
description:
'Do not separate `patch` and `minor` upgrades into separate PRs for the same dependency.',
separateMinorPatch: false,
},
dependencyDashboard: {
dependencyDashboard: true,
description: 'Enable Renovate Dependency Dashboard creation.',
},
dependencyDashboardApproval: {
dependencyDashboardApproval: true,
description: 'Enable Renovate Dependency Dashboard approval workflow.',
},
disableDependencyDashboard: {
dependencyDashboard: false,
description: 'Disable Renovate Dependency Dashboard creation.',
},
disableDevDependencies: {
description: 'Do not update `devDependencies` versions/ranges.',
packageRules: [
{
enabled: false,
matchDepTypes: ['devDependencies'],
},
],
},
disableDigestUpdates: {
description: 'Disable `digest` and Git hash updates.',
digest: {
enabled: false,
},
},
disableDomain: {
description: 'Disable requests to a particular domain.',
hostRules: [
{
enabled: false,
matchHost: '{{arg0}}',
},
],
},
disableHost: {
description: 'Disable requests to a particular host.',
hostRules: [
{
enabled: false,
matchHost: 'https://{{arg0}}',
},
],
},
disableLockFiles: {
description: 'Disable lock file updates.',
updateLockFiles: false,
},
disableMajorUpdates: {
description: 'Disable `major` updates.',
major: {
enabled: false,
},
},
disablePeerDependencies: {
description: 'Do not update `peerDependencies` versions/ranges.',
packageRules: [
{
enabled: false,
matchDepTypes: ['peerDependencies'],
},
],
},
disablePrControls: {
description: 'Remove the checkbox controls from PRs.',
prBodyTemplate:
'{{{header}}}{{{table}}}{{{notes}}}{{{changelogs}}}{{{configDescription}}}{{{footer}}}',
},
disableRateLimiting: {
description: 'Remove hourly and concurrent rate limits.',
prConcurrentLimit: 0,
prHourlyLimit: 0,
},
disableRenovate: {
description: 'Disable Renovate.',
enabled: false,
},
disableVulnerabilityAlerts: {
description: 'Disable vulnerability alerts completely.',
vulnerabilityAlerts: {
enabled: false,
},
},
docker: {
description: 'Keep Dockerfile `FROM` sources updated.',
'docker-compose': {
enabled: true,
},
dockerfile: {
enabled: true,
},
},
doNotPinPackage: {
description: 'Disable version pinning for `{{arg0}}`.',
packageRules: [
{
matchPackageNames: ['{{arg0}}'],
rangeStrategy: 'replace',
},
],
},
enablePreCommit: {
description: 'Enable the pre-commit manager.',
'pre-commit': {
enabled: true,
},
},
enableRenovate: {
description: 'Enable Renovate.',
enabled: true,
},
enableVulnerabilityAlerts: {
description: 'Raise PR when vulnerability alerts are detected.',
vulnerabilityAlerts: {
enabled: true,
},
},
enableVulnerabilityAlertsWithLabel: {
description:
'Raise PR when vulnerability alerts are detected with label `{{arg0}}`.',
vulnerabilityAlerts: {
enabled: true,
labels: ['{{arg0}}'],
},
},
followTag: {
description:
'For package `{{arg0}}`, strictly follow release tag `{{arg1}}`.',
packageRules: [
{
followTag: '{{arg1}}',
matchPackageNames: ['{{arg0}}'],
},
],
},
githubComToken: {
description:
'Use provided token for `github.com` lookups. Do not configure this if you are already running on `github.com`.',
hostRules: [
{
encrypted: {
token: '{{arg0}}',
},
matchHost: 'github.com',
},
],
},
gitSignOff: {
commitBody: 'Signed-off-by: {{{gitAuthor}}}',
description: 'Append `Signed-off-by:` to signoff Git commits.',
},
gomod: {
description: 'Enable Go modules support.',
gomod: {
enabled: true,
},
},
group: {
description: 'Group `{{arg1}}` packages into same branch/PR.',
packageRules: [
{
extends: ['{{arg0}}'],
groupName: '{{arg1}}',
},
],
},
ignoreModulesAndTests: {
description:
'Ignore `node_modules`, `bower_components`, `vendor` and various test/tests directories.',
ignorePaths: [
'**/node_modules/**',
'**/bower_components/**',
'**/vendor/**',
'**/examples/**',
'**/__tests__/**',
'**/test/**',
'**/tests/**',
'**/__fixtures__/**',
],
},
ignoreUnstable: {
description:
'Upgrade to unstable versions only if the existing version is unstable.',
ignoreUnstable: true,
},
includeNodeModules: {
description:
'Include `package.json` files found within `node_modules` folders or `bower_components`.',
ignorePaths: [],
},
label: {
description: 'Apply label `{{arg0}}` to PRs.',
labels: ['{{arg0}}'],
},
labels: {
description: 'Apply labels `{{arg0}}` and `{{arg1}}` to PRs.',
labels: ['{{arg0}}', '{{arg1}}'],
},
maintainLockFilesDisabled: {
description:
'Update existing lock files only when `package.json` is modified.',
lockFileMaintenance: {
enabled: false,
},
},
maintainLockFilesMonthly: {
description:
'Run lock file maintenance (updates) on the first day of each month.',
lockFileMaintenance: {
enabled: true,
extends: ['schedule:monthly'],
},
},
maintainLockFilesWeekly: {
description: 'Run lock file maintenance (updates) early Monday mornings.',
lockFileMaintenance: {
enabled: true,
extends: ['schedule:weekly'],
},
},
meteor: {
description: 'Keep Meteor Npm.depends packages updated.',
meteor: {
enabled: true,
},
},
noUnscheduledUpdates: {
description: 'Only update branches when scheduled.',
updateNotScheduled: false,
},
npm: {
description: 'Keep `package.json` npm dependencies updated.',
npm: {
enabled: true,
},
},
pathSemanticCommitType: {
description:
'Use semanticCommitType `{{arg0}}` for all package files matching path `{{arg1}}`.',
packageRules: [
{
matchFileNames: ['{{arg0}}'],
semanticCommitType: '{{arg1}}',
},
],
},
pinAllExceptPeerDependencies: {
description: 'Pin all dependency versions except `peerDependencies`.',
packageRules: [
{
matchPackagePatterns: ['*'],
rangeStrategy: 'pin',
},
{
matchDepTypes: ['engines', 'peerDependencies'],
rangeStrategy: 'auto',
},
],
},
pinDependencies: {
description:
'Pin dependency versions where `depType=dependencies`. Usually applies only to non-dev dependencies in `package.json`.',
packageRules: [
{
matchDepTypes: ['dependencies'],
rangeStrategy: 'pin',
},
],
},
pinDevDependencies: {
description: 'Pin dependency versions for `devDependencies`.',
packageRules: [
{
matchDepTypes: ['devDependencies'],
rangeStrategy: 'pin',
},
],
},
pinDigestsDisabled: {
description: 'Disable pinning of Docker dependency digests.',
pinDigests: false,
},
pinOnlyDevDependencies: {
description:
'Pin dependency versions for `devDependencies` and retain SemVer ranges for others.',
packageRules: [
{
matchPackagePatterns: ['*'],
rangeStrategy: 'replace',
},
{
matchDepTypes: ['devDependencies'],
rangeStrategy: 'pin',
},
{
matchDepTypes: ['peerDependencies'],
rangeStrategy: 'widen',
},
],
},
pinSkipCi: {
description: 'Add `[skip ci]` to commit message body whenever pinning.',
pin: {
commitBody: '[skip ci]',
},
},
pinVersions: {
description:
'Use version pinning (maintain a single version only and not SemVer ranges).',
rangeStrategy: 'pin',
},
prConcurrentLimit10: {
description: 'Limit to maximum 10 open PRs at any time.',
prConcurrentLimit: 10,
},
prConcurrentLimit20: {
description: 'Limit to maximum 20 open PRs at any time.',
prConcurrentLimit: 20,
},
prConcurrentLimitNone: {
description: 'Remove limit for open PRs at any time.',
prConcurrentLimit: 0,
},
preserveSemverRanges: {
description:
'Preserve (but continue to upgrade) any existing SemVer ranges.',
packageRules: [{ matchPackagePatterns: ['*'], rangeStrategy: 'replace' }],
},
prHourlyLimit1: {
description: 'Rate limit PR creation to a maximum of one per hour.',
prHourlyLimit: 1,
},
prHourlyLimit2: {
description: 'Rate limit PR creation to a maximum of two per hour.',
prHourlyLimit: 2,
},
prHourlyLimit4: {
description: 'Rate limit PR creation to a maximum of four per hour.',
prHourlyLimit: 4,
},
prHourlyLimitNone: {
description: 'Removes rate limit for PR creation per hour.',
prHourlyLimit: 0,
},
prImmediately: {
description: 'Raise PRs immediately (after branch is created).',
prCreation: 'immediate',
},
prNotPending: {
description:
'Wait for branch tests to pass or fail before creating the PR.',
prCreation: 'not-pending',
},
rebaseStalePrs: {
description:
'Rebase existing PRs any time the base branch has been updated.',
rebaseWhen: 'behind-base-branch',
},
renovatePrefix: {
branchPrefix: 'renovate/',
description: 'Add the `renovate/` prefix to all branch names.',
},
respectLatest: {
description: 'Upgrade versions up to the "latest" tag in the npm registry.',
respectLatest: true,
},
reviewer: {
description: 'Add `{{arg0}}` as reviewer for PRs.',
reviewers: ['{{arg0}}'],
},
semanticCommits: {
description: 'Use semantic prefixes for commit messages and PR titles.',
semanticCommits: 'enabled',
},
semanticCommitScope: {
description:
'Use semantic commit scope `{{arg0}}` for all commits and PR titles.',
semanticCommitScope: '{{arg0}}',
},
semanticCommitScopeDisabled: {
description: 'Disable semantic commit scope for all commits and PR titles.',
semanticCommitScope: null,
},
semanticCommitsDisabled: {
description: 'Disable semantic prefixes for commit messages and PR titles.',
semanticCommits: 'disabled',
},
semanticCommitType: {
description:
'Use `{{arg0}}` as semantic commit type for commit messages and PR titles.',
semanticCommitType: '{{arg0}}',
},
semanticCommitTypeAll: {
description:
'If Renovate detects semantic commits, it will use semantic commit type `{{arg0}}` for all commits.',
packageRules: [
{
matchFileNames: ['**/*'],
semanticCommitType: '{{arg0}}',
},
],
},
semanticPrefixChore: {
description:
'Use `chore` as semantic commit type for commit messages and PR titles.',
extends: [':semanticCommitType(chore)'],
},
semanticPrefixFix: {
description:
'Use `fix` as semantic commit type for commit messages and PR titles.',
extends: [':semanticCommitType(fix)'],
},
semanticPrefixFixDepsChoreOthers: {
description:
'Use semantic commit type `fix` for dependencies and `chore` for all others if semantic commits are in use.',
packageRules: [
{
matchPackagePatterns: ['*'],
semanticCommitType: 'chore',
},
{
matchDepTypes: ['dependencies', 'require'],
semanticCommitType: 'fix',
},
{
matchDatasources: ['maven'],
matchDepTypes: [
'compile',
'provided',
'runtime',
'system',
'import',
'parent',
],
semanticCommitType: 'fix',
},
],
},
separateMajorReleases: {
description:
'Separate `major` versions of dependencies into individual branches/PRs.',
separateMajorMinor: true,
},
separateMultipleMajorReleases: {
description:
'Separate each `major` version of dependencies into individual branches/PRs.',
separateMajorMinor: true,
separateMultipleMajor: true,
},
separateMultipleMinorReleases: {
description:
'Separate each `minor` version of dependencies into individual branches/PRs.',
separateMultipleMinor: true,
},
separatePatchReleases: {
description:
'Separate `patch` and `minor` releases of dependencies into separate PRs.',
separateMinorPatch: true,
},
skipStatusChecks: {
description: 'Skip status checks and automerge right away.',
ignoreTests: true,
},
timezone: {
description: 'Evaluate schedules according to timezone `{{arg0}}`.',
timezone: '{{arg0}}',
},
updateNotScheduled: {
description: 'Keep existing branches updated even when not scheduled.',
updateNotScheduled: true,
},
widenPeerDependencies: {
description:
'Always widen `peerDependencies` SemVer ranges when updating, instead of replacing.',
packageRules: [
{
matchDepTypes: ['peerDependencies'],
rangeStrategy: 'widen',
},
],
},
};