forked from renovatebot/renovate
-
Notifications
You must be signed in to change notification settings - Fork 0
/
renovate-schema.json
1447 lines (1447 loc) · 45.3 KB
/
renovate-schema.json
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
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"title": "JSON schema for Renovate config files (https://renovatebot.com/)",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"onboardingBranch": {
"description": "Change this value in order to override the default onboarding branch name.",
"type": "string",
"default": "renovate/configure"
},
"onboardingPrTitle": {
"description": "Change this value in order to override the default onboarding PR title.",
"type": "string",
"default": "Configure Renovate"
},
"productLinks": {
"description": "Links which are embedded within PRs, issues, etc",
"type": "object",
"default": {
"documentation": "https://docs.renovatebot.com/",
"help": "https://github.com/renovatebot/config-help/issues",
"homepage": "https://github.com/renovatebot/renovate"
},
"additionalProperties": {
"type": "string",
"format": "uri"
},
"$ref": "#"
},
"extends": {
"description": "Configuration presets to use/extend. Note: does not work if configured in config.js",
"type": "array",
"items": {
"type": "string"
}
},
"ignorePresets": {
"description": "A list of presets to ignore, including nested ones inside `extends`",
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"description": "Plain text description for a config or preset",
"type": "array",
"items": {
"type": "string"
}
},
"enabled": {
"description": "Enable or disable the bot",
"type": "boolean"
},
"force": {
"description": "Any configuration defined within this object will force override existing settings",
"type": "object",
"$ref": "#"
},
"forceCli": {
"description": "Whether CLI configuration options should be moved to the `force` config section",
"type": "boolean",
"default": true
},
"dryRun": {
"description": "If enabled, perform a dry run by logging messages instead of creating/updating/deleting branches and PRs",
"type": "boolean",
"default": false
},
"printConfig": {
"description": "If enabled, log the full resolved config for each repo, including resolved presets",
"type": "boolean",
"default": false
},
"binarySource": {
"description": "Where to source binaries like `npm` and `yarn` from, choices are `auto`, `global` and `docker`",
"type": "string",
"enum": ["auto", "global", "docker"],
"default": "auto"
},
"baseDir": {
"description": "The base directory for Renovate to store local files, including repository files and cache. If left empty, Renovate will create its own temporary directory to use.",
"type": "string"
},
"cacheDir": {
"description": "The directory for Renovate for storing caches. If left empty, Renovate will create a subdirectory within `baseDir` to use.",
"type": "string"
},
"dockerMapDotfiles": {
"description": "Map relevant home directory dotfiles into containers when binarySource=docker.",
"type": "boolean",
"default": false
},
"dockerUser": {
"description": "Specify UID and GID for docker-based binaries when binarySource=docker is used.",
"type": "string"
},
"logLevel": {
"description": "Logging level",
"type": "string",
"enum": ["fatal", "error", "warn", "info", "debug", "trace"],
"default": "info"
},
"logFile": {
"description": "Log file path",
"type": "string"
},
"logFileLevel": {
"description": "Log file log level",
"type": "string",
"default": "debug"
},
"onboarding": {
"description": "Require a Configuration PR first",
"type": "boolean"
},
"onboardingConfig": {
"description": "Configuration to use in onboarding PRs",
"type": "object",
"default": {},
"$ref": "#"
},
"includeForks": {
"description": "Whether to process forked repositories or not. By default, all forked repositories are skipped over.",
"type": "boolean",
"default": false
},
"forkMode": {
"description": "Set to true to fork the source repository and create branches there instead",
"type": "boolean",
"default": false
},
"requireConfig": {
"description": "Set to true if repositories must have a config to activate.",
"type": "boolean",
"default": true
},
"optimizeForDisabled": {
"description": "Set to true to first check for disabling in config before cloning",
"type": "boolean",
"default": false
},
"masterIssue": {
"description": "Whether to create a \"Master Issue\" within the repository.",
"type": "boolean",
"default": false
},
"masterIssueApproval": {
"description": "Whether updates should require manual approval from within the Master Issue before creation.",
"type": "boolean",
"default": false
},
"masterIssueAutoclose": {
"description": "Set to `true` and Renovate will autoclose the Master Issue if there are no updates.",
"type": "boolean",
"default": false
},
"masterIssueTitle": {
"description": "Title to use for the Master Issue",
"type": "string",
"default": "Update Dependencies (Renovate Bot)"
},
"configWarningReuseIssue": {
"description": "Set this to false and Renovate will open each config warning in a new issue instead of reopening/reusing an existing issue.",
"type": "boolean",
"default": true
},
"privateKey": {
"description": "Server-side private key",
"type": "string"
},
"encrypted": {
"description": "A configuration object containing configuration encrypted with project key.",
"type": "object",
"default": null,
"$ref": "#"
},
"timezone": {
"description": "[IANA Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)",
"type": "string"
},
"schedule": {
"description": "Times of day/week to limit branch creation to",
"type": "array",
"items": {
"type": "string"
},
"default": "at any time"
},
"updateNotScheduled": {
"description": "Whether to update (but not create) branches when not scheduled",
"type": "boolean"
},
"persistRepoData": {
"description": "If set to true, repository data will preserved between runs instead of deleted.",
"type": "boolean",
"default": false
},
"trustLevel": {
"description": "Set this to \"high\" if the bot should trust the repository owners/contents",
"type": "string",
"default": "low"
},
"ignoreScripts": {
"description": "Configure this to true if trustLevel is high but you wish to skip running scripts when updating lock files",
"type": "boolean",
"default": false
},
"platform": {
"description": "Platform type of repository",
"type": "string",
"enum": ["azure", "bitbucket", "bitbucket-server", "github", "gitlab"],
"default": "github"
},
"endpoint": {
"description": "Custom endpoint to use",
"type": "string",
"default": null
},
"token": {
"description": "Repository Auth Token",
"type": "string"
},
"username": {
"description": "Username for authentication. Currently Bitbucket only",
"type": "string"
},
"password": {
"description": "Password for authentication. Currently Bitbucket only (AppPassword).",
"type": "string"
},
"npmrc": {
"description": "String copy of npmrc file. Use \\n instead of line breaks",
"type": "string"
},
"npmToken": {
"description": "npm token used for authenticating with the default registry",
"type": "string"
},
"yarnrc": {
"description": "String copy of yarnrc file. Use \\n instead of line breaks",
"type": "string"
},
"updateLockFiles": {
"description": "Set to false to disable lock file updating",
"type": "boolean"
},
"skipInstalls": {
"description": "Skip installing modules/dependencies if lock file updating is possible alone",
"type": "boolean",
"default": null
},
"ignoreNpmrcFile": {
"description": "Whether to ignore any .npmrc file found in repository",
"type": "boolean",
"default": false
},
"autodiscover": {
"description": "Autodiscover all repositories",
"type": "boolean",
"default": false
},
"autodiscoverFilter": {
"description": "Filter the list of autodiscovered repositories",
"type": "string",
"default": null
},
"prCommitsPerRunLimit": {
"description": "Set a maximum number of commits per Renovate run. Default is no limit.",
"type": "integer",
"default": 0
},
"repositories": {
"description": "List of Repositories",
"type": "array"
},
"baseBranches": {
"description": "An array of one or more custom base branches to be processed. If left empty, the default branch will be chosen",
"type": "array"
},
"gitAuthor": {
"description": "Author to use for git commits. RFC5322",
"type": "string"
},
"gitPrivateKey": {
"description": "PGP key to use for signing git commits",
"type": "string"
},
"enabledManagers": {
"description": "A list of package managers to enable. If defined, then all managers not on the list are disabled.",
"type": "array"
},
"includePaths": {
"description": "Include package files only within these defined paths",
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"ignorePaths": {
"description": "Skip any package file whose path matches one of these. Can be string or glob pattern",
"type": "array",
"items": {
"type": "string"
},
"default": ["**/node_modules/**", "**/bower_components/**"]
},
"excludeCommitPaths": {
"description": "A file that matches any of these glob patterns will not be committed, even if it has been updated.",
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"engines": {
"description": "Configuration specifically for `package.json`>`engines`",
"type": "object",
"default": {},
"$ref": "#"
},
"aliases": {
"description": "Aliases for registries, package manager specific",
"type": "object",
"default": {},
"additionalProperties": {
"type": "string",
"format": "uri"
},
"$ref": "#"
},
"registryUrls": {
"description": "List of URLs to try for dependency lookup. Package manager-specific",
"type": "array",
"items": {
"type": "string"
},
"default": null
},
"versionScheme": {
"description": "Version scheme to use for filtering and comparisons",
"type": "string",
"enum": [
"cargo",
"composer",
"docker",
"git",
"hashicorp",
"hex",
"ivy",
"loose",
"maven",
"node",
"npm",
"nuget",
"pep440",
"poetry",
"regex",
"ruby",
"semver",
"swift"
],
"default": "semver"
},
"azureAutoComplete": {
"description": "If set to true, Azure DevOps PRs will be set to auto-complete after all (if any) branch policies have been met",
"type": "boolean",
"default": false
},
"azureWorkItemId": {
"description": "The id of an existing work item on Azure Boards to link to each PR",
"type": "integer",
"default": 0
},
"ignoreDeps": {
"description": "Dependencies to ignore",
"type": "array",
"items": {
"type": "string"
}
},
"packageRules": {
"description": "Rules for matching package names",
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"languages": {
"description": "List of languages to match (e.g. [\"python\"]). Valid only within `packageRules` object",
"type": "array",
"items": {
"type": "string"
}
},
"baseBranchList": {
"description": "List of branches to match (e.g. [\"master\"]). Valid only within `packageRules` object",
"type": "array",
"items": {
"type": "string"
}
},
"managers": {
"description": "List of package managers to match (e.g. [\"pipenv\"]). Valid only within `packageRules` object",
"type": "array",
"items": {
"type": "string"
}
},
"datasources": {
"description": "List of datasources to match (e.g. [\"orb\"]). Valid only within `packageRules` object",
"type": "array",
"items": {
"type": "string"
}
},
"depTypeList": {
"description": "List of depTypes to match (e.g. [`peerDependencies`]). Valid only within `packageRules` object",
"type": "array",
"items": {
"type": "string"
}
},
"packageNames": {
"description": "Package names to match. Valid only within `packageRules` object",
"type": "array",
"items": {
"type": "string"
}
},
"excludePackageNames": {
"description": "Package names to exclude. Valid only within `packageRules` object",
"type": "array",
"items": {
"type": "string"
}
},
"packagePatterns": {
"description": "Package name patterns to match. Valid only within `packageRules` object.",
"type": "array",
"items": {
"type": "string",
"format": "regex"
}
},
"excludePackagePatterns": {
"description": "Package name patterns to exclude. Valid only within `packageRules` object.",
"type": "array",
"items": {
"type": "string",
"format": "regex"
}
},
"matchCurrentVersion": {
"description": "A version or version range to match against the current version of a package. Valid only within `packageRules` object",
"type": "string"
},
"sourceUrlPrefixes": {
"description": "A list of source URL prefixes to match against, commonly used for grouping of monorepos or packages from the same organization.",
"type": "array",
"items": {
"type": "string"
}
},
"updateTypes": {
"description": "Update types to match against (major, minor, pin, etc). Valid only within `packageRules` object.",
"type": "array",
"items": {
"type": "string",
"enum": [
"major",
"minor",
"patch",
"pin",
"digest",
"lockFileMaintenance",
"rollback",
"bump"
]
}
},
"paths": {
"description": "List of strings or glob patterns to match against package files. Applicable inside packageRules only",
"type": "array",
"items": {
"type": "string"
}
},
"allowedVersions": {
"description": "A semver range defining allowed versions for dependencies",
"type": "string"
}
}
}
]
}
},
"pinDigests": {
"description": "Whether to add digests to Dockerfile source images",
"type": "boolean",
"default": false
},
"separateMajorMinor": {
"description": "If set to false, it will upgrade dependencies to latest release only, and not separate major/minor branches",
"type": "boolean"
},
"separateMultipleMajor": {
"description": "If set to true, PRs will be raised separately for each available major upgrade version",
"type": "boolean",
"default": false
},
"separateMinorPatch": {
"description": "If set to true, it will separate minor and patch updates into separate branches",
"type": "boolean",
"default": false
},
"ignoreUnstable": {
"description": "Ignore versions with unstable semver",
"type": "boolean"
},
"ignoreDeprecated": {
"description": "Ignore deprecated versions unless the current version is deprecated",
"type": "boolean",
"default": true
},
"followTag": {
"description": "If defined, packages will follow this release tag exactly.",
"type": "string"
},
"respectLatest": {
"description": "Ignore versions newer than npm \"latest\" version",
"type": "boolean"
},
"rangeStrategy": {
"description": "Policy for how to modify/update existing ranges.",
"type": "string",
"enum": ["auto", "pin", "bump", "replace", "widen", "update-lockfile"],
"default": "replace"
},
"branchPrefix": {
"description": "Prefix to use for all branch names",
"type": "string",
"default": "renovate/"
},
"bumpVersion": {
"description": "Bump the version in the package.json being updated",
"type": "string",
"enum": ["major", "minor", "patch"]
},
"major": {
"description": "Configuration to apply when an update type is major",
"type": "object",
"default": {},
"$ref": "#"
},
"minor": {
"description": "Configuration to apply when an update type is minor",
"type": "object",
"default": {},
"$ref": "#"
},
"patch": {
"description": "Configuration to apply when an update type is patch. Only applies if `separateMinorPatch` is set to true",
"type": "object",
"default": {},
"$ref": "#"
},
"pin": {
"description": "Configuration to apply when an update type is pin.",
"type": "object",
"default": {
"unpublishSafe": false,
"recreateClosed": true,
"rebaseStalePrs": true,
"groupName": "Pin Dependencies",
"groupSlug": "pin-dependencies",
"commitMessageAction": "Pin",
"group": {
"commitMessageTopic": "dependencies",
"commitMessageExtra": ""
}
},
"$ref": "#"
},
"digest": {
"description": "Configuration to apply when updating a digest (no change in tag/version)",
"type": "object",
"default": {
"branchTopic": "{{{depNameSanitized}}}-digest",
"commitMessageExtra": "to {{newDigestShort}}",
"commitMessageTopic": "{{{depName}}} commit hash"
},
"$ref": "#"
},
"semanticCommits": {
"description": "Enable semantic commit prefixes for commits and PR titles",
"type": "boolean",
"default": null
},
"semanticCommitType": {
"description": "Commit type to use if semantic commits is enabled",
"type": "string",
"default": "chore"
},
"semanticCommitScope": {
"description": "Commit scope to use if semantic commits are enabled",
"type": "string",
"default": "deps"
},
"rollbackPrs": {
"description": "Create PRs to roll back versions if the current version is not found in the registry",
"type": "boolean",
"default": false
},
"recreateClosed": {
"description": "Recreate PRs even if same ones were closed previously",
"type": "boolean",
"default": false
},
"rebaseConflictedPrs": {
"description": "Auto-rebase when there is conflict in PRs",
"type": "boolean",
"default": true
},
"rebaseStalePrs": {
"description": "Rebase any PRs that are not up-to-date with the base branch",
"type": "boolean",
"default": null
},
"rebaseLabel": {
"description": "Label to use to request the bot to rebase a PR manually",
"type": "string",
"default": "rebase"
},
"statusCheckVerify": {
"description": "Set a verify status check for all PRs",
"type": "boolean",
"default": false
},
"unpublishSafe": {
"description": "Set a status check for unpublish-safe upgrades",
"type": "boolean",
"default": false
},
"stabilityDays": {
"description": "Number of days required before a new release is considered to be stabilized.",
"type": "integer",
"default": 0
},
"prCreation": {
"description": "When to create the PR for a branch.",
"type": "string",
"enum": ["immediate", "not-pending", "status-success", "approval"],
"default": "immediate"
},
"prNotPendingHours": {
"description": "Timeout in hours for when prCreation=not-pending",
"type": "integer",
"default": 25
},
"prHourlyLimit": {
"description": "Rate limit PRs to maximum x created per hour. 0 (default) means no limit.",
"type": "integer",
"default": 0
},
"prConcurrentLimit": {
"description": "Limit to a maximum of x concurrent branches/PRs. 0 (default) means no limit.",
"type": "integer",
"default": 0
},
"prPriority": {
"description": "Set sorting priority for PR creation. PRs with higher priority are created first, negative priority last.",
"type": "integer",
"default": 0
},
"bbUseDefaultReviewers": {
"description": "Use the default reviewers (Bitbucket only).",
"type": "boolean",
"default": true
},
"automerge": {
"description": "Whether to automerge branches/PRs automatically, without human intervention",
"type": "boolean",
"default": false
},
"automergeType": {
"description": "How to automerge, if enabled.",
"type": "string",
"enum": ["branch", "pr", "pr-comment"],
"default": "pr"
},
"automergeComment": {
"description": "PR comment to add to trigger automerge. Used only if automergeType=pr-comment",
"type": "string",
"default": "automergeComment"
},
"requiredStatusChecks": {
"description": "List of status checks that must pass before automerging. Set to null to enable automerging without tests.",
"type": "array",
"items": {
"type": "string"
}
},
"vulnerabilityAlerts": {
"description": "Config to apply when a PR is necessary due to vulnerability of existing package version.",
"type": "object",
"default": {
"groupName": null,
"schedule": [],
"masterIssueApproval": false,
"rangeStrategy": "update-lockfile",
"commitMessageSuffix": "[SECURITY]"
},
"$ref": "#"
},
"branchName": {
"description": "Branch name template",
"type": "string",
"default": "{{{branchPrefix}}}{{{managerBranchPrefix}}}{{{branchTopic}}}"
},
"managerBranchPrefix": {
"description": "Branch manager prefix",
"type": "string",
"default": ""
},
"branchTopic": {
"description": "Branch topic",
"type": "string",
"default": "{{{depNameSanitized}}}-{{{newMajor}}}{{#if isPatch}}.{{{newMinor}}}{{/if}}.x{{#if isLockfileUpdate}}-lockfile{{/if}}"
},
"commitMessage": {
"description": "Message to use for commit messages and pull request titles",
"type": "string",
"default": "{{{commitMessagePrefix}}} {{{commitMessageAction}}} {{{commitMessageTopic}}} {{{commitMessageExtra}}} {{{commitMessageSuffix}}}"
},
"commitBody": {
"description": "Commit message body template. Will be appended to commit message, separated by two line returns.",
"type": "string"
},
"commitBodyTable": {
"description": "If enabled, append a table in the commit message body describing all updates in the commit",
"type": "boolean",
"default": false
},
"commitMessagePrefix": {
"description": "Prefix to add to start of commit messages and PR titles. Uses a semantic prefix if semanticCommits enabled",
"type": "string"
},
"commitMessageAction": {
"description": "Action verb to use in commit messages and PR titles",
"type": "string",
"default": "Update"
},
"commitMessageTopic": {
"description": "The upgrade topic/noun used in commit messages and PR titles",
"type": "string",
"default": "dependency {{depName}}"
},
"commitMessageExtra": {
"description": "Extra description used after the commit message topic - typically the version",
"type": "string",
"default": "to {{#if isMajor}}v{{{newMajor}}}{{else}}{{#if isSingleVersion}}v{{{toVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}"
},
"commitMessageSuffix": {
"description": "Suffix to add to end of commit messages and PR titles.",
"type": "string"
},
"prTitle": {
"description": "Pull Request title template (deprecated). Now uses commitMessage.",
"type": "string",
"default": null
},
"prFooter": {
"description": "Pull Request footer template",
"type": "string",
"default": "This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate)."
},
"lockFileMaintenance": {
"description": "Configuration for lock file maintenance",
"type": "object",
"default": {
"enabled": false,
"recreateClosed": true,
"rebaseStalePrs": true,
"branchTopic": "lock-file-maintenance",
"commitMessageAction": "Lock file maintenance",
"commitMessageTopic": null,
"commitMessageExtra": null,
"schedule": ["before 5am on monday"],
"groupName": null,
"prBodyDefinitions": {
"Change": "All locks refreshed"
}
},
"$ref": "#"
},
"lazyGrouping": {
"description": "Use group names only when multiple dependencies upgraded",
"type": "boolean",
"default": true
},
"groupName": {
"description": "Human understandable name for the dependency group",
"type": "string",
"default": null
},
"groupSlug": {
"description": "Slug to use for group (e.g. in branch name). Will be calculated from groupName if null",
"type": "string",
"default": null
},
"group": {
"description": "Config if groupName is enabled",
"type": "object",
"default": {
"branchTopic": "{{{groupSlug}}}",
"commitMessageTopic": "{{{groupName}}}"
},
"$ref": "#"
},
"labels": {
"description": "Labels to add to Pull Request",
"type": "array",
"items": {
"type": "string"
}
},
"assignees": {
"description": "Assignees for Pull Request (either username or email address depending on the platform)",
"type": "array",
"items": {
"type": "string"
}
},
"assigneesSampleSize": {
"description": "Take a random sample of given size from assignees.",
"type": "integer",
"default": null
},
"assignAutomerge": {
"description": "Assign reviewers and assignees even if the PR is to be automerged",
"type": "boolean",
"default": false
},
"reviewers": {
"description": "Requested reviewers for Pull Requests (either username or email address depending on the platform)",
"type": "array",
"items": {
"type": "string"
}
},
"reviewersSampleSize": {
"description": "Take a random sample of given size from reviewers.",
"type": "integer",
"default": null
},
"additionalReviewers": {
"description": "Additional reviewers for Pull Requests (in contrast to `reviewers`, this option adds to the existing reviewer list, rather than replacing it)",
"type": "array",
"items": {
"type": "string"
}
},
"fileMatch": {
"description": "RegEx (re2) pattern for matching manager files",
"type": "array",
"items": {
"type": "string",
"format": "regex"
}
},
"js": {
"description": "Configuration object for javascript language",
"type": "object",
"default": {},
"$ref": "#"
},
"npm": {
"description": "Configuration object for npm package.json renovation",
"type": "object",
"default": {
"fileMatch": ["(^|/)package.json$"],
"rollbackPrs": true,
"versionScheme": "npm",
"prBodyDefinitions": {
"Change": "[{{#if displayFrom}}`{{{displayFrom}}}` -> {{else}}{{#if currentValue}}`{{{currentValue}}}` -> {{/if}}{{/if}}{{#if displayTo}}`{{{displayTo}}}`{{else}}`{{{newValue}}}`{{/if}}](https://renovatebot.com/diffs/npm/{{{depNameEscaped}}}/{{{fromVersion}}}/{{{toVersion}}})"
}
},
"$ref": "#"
},
"meteor": {
"description": "Configuration object for meteor package.js renovation",
"type": "object",
"default": {
"fileMatch": ["(^|/)package.js$"]
},
"$ref": "#"
},
"bazel": {
"description": "Configuration object for bazel WORKSPACE renovation",
"type": "object",
"default": {
"fileMatch": ["(^|/)WORKSPACE$", "\\.bzl$"]
},
"$ref": "#"
},
"buildkite": {
"description": "Configuration object for buildkite pipeline renovation",
"type": "object",
"default": {
"fileMatch": ["buildkite\\.ya?ml", "\\.buildkite/.+\\.ya?ml$"],
"commitMessageTopic": "buildkite plugin {{depName}}",
"commitMessageExtra": "to {{#if isMajor}}v{{{newMajor}}}{{else}}{{{newValue}}}{{/if}}",
"managerBranchPrefix": "buildkite-"
},
"$ref": "#"
},
"golang": {
"description": "Configuration object for Go language",
"type": "object",
"default": {
"commitMessageTopic": "module {{depNameShort}}"
},
"$ref": "#"
},
"gomod": {
"description": "Configuration object for Go modules renovation",
"type": "object",
"default": {
"fileMatch": ["(^|/)go.mod$"]
},
"$ref": "#"
},
"postUpdateOptions": {
"description": "Enable post-update options to be run after package/artifact updating",
"type": "array",
"default": []
},
"ruby": {
"description": "Configuration object for ruby language",
"type": "object",
"default": {},
"$ref": "#"
},
"bundler": {
"description": "Configuration object for bundler Gemfiles",
"type": "object",
"default": {
"fileMatch": ["(^|/)Gemfile$"],
"versionScheme": "ruby"
},
"$ref": "#"
},
"ruby-version": {
"description": "Configuration object for .ruby-version updating",
"type": "object",
"default": {
"fileMatch": ["(^|/)\\.ruby-version$"],
"versionScheme": "ruby"
},
"$ref": "#"
},
"terraform": {
"description": "Configuration object for Terraform dependencies renovation",
"type": "object",
"default": {
"commitMessageTopic": "Terraform {{managerData.terraformDependencyType}} {{depNameShort}}",
"fileMatch": ["\\.tf$"],
"versionScheme": "hashicorp"
},
"$ref": "#"
},
"mix": {
"description": "Configuration object for Mix module renovation",
"type": "object",
"default": {
"fileMatch": ["(^|/)mix\\.exs$"],
"versionScheme": "hex"
},
"$ref": "#"
},
"rust": {
"description": "Configuration option for Rust package management.",
"type": "object",
"default": {},
"$ref": "#"
},
"cargo": {
"description": "Configuration object for Cargo crate renovation.",
"type": "object",
"default": {
"commitMessageTopic": "Rust crate {{depName}}",
"managerBranchPrefix": "rust-",
"fileMatch": ["(^|/)Cargo.toml$"],
"versionScheme": "cargo",
"rangeStrategy": "bump"
},
"$ref": "#"