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.

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

fix(config): improve descriptions for default presets #12073

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion lib/config/presets/__snapshots__/index.spec.ts.snap
Expand Up @@ -31,7 +31,7 @@ Object {
"Use <code>renovate/</code> as prefix for all branch names",
"If semantic commits detected, use semantic commit type <code>fix</code> for dependencies and <code>chore</code> for all others",
"Require all status checks to pass before any automerging",
"Pin dependency versions for <code>devDependencies</code> and retain semver ranges for others",
"Pin dependency versions for <code>devDependencies</code> and retain SemVer ranges for others",
],
"ignoreTests": false,
"ignoreUnstable": true,
Expand Down
2 changes: 1 addition & 1 deletion lib/config/presets/index.spec.ts
Expand Up @@ -649,7 +649,7 @@ Object {
const res = await presets.getPreset(':pinVersions(foo, bar)', {});
expect(res).toEqual({
description: [
'Use version pinning (maintain a single version only and not semver ranges)',
'Use version pinning (maintain a single version only and not SemVer ranges)',
],
rangeStrategy: 'pin',
});
Expand Down
25 changes: 13 additions & 12 deletions lib/config/presets/internal/default.ts
Expand Up @@ -2,11 +2,11 @@ import type { Preset } from '../types';

export const presets: Record<string, Preset> = {
enableRenovate: {
description: 'Enable renovate',
description: 'Enable Renovate',
enabled: true,
},
disableRenovate: {
description: 'Disable renovate',
description: 'Disable Renovate',
enabled: false,
},
disableMajorUpdates: {
Expand Down Expand Up @@ -60,12 +60,12 @@ export const presets: Record<string, Preset> = {
},
pinVersions: {
description:
'Use version pinning (maintain a single version only and not semver ranges)',
'Use version pinning (maintain a single version only and not SemVer ranges)',
rangeStrategy: 'pin',
},
preserveSemverRanges: {
description:
'Preserve (but continue to upgrade) any existing semver ranges',
'Preserve (but continue to upgrade) any existing SemVer ranges',
rangeStrategy: 'replace',
},
pinAllExceptPeerDependencies: {
Expand Down Expand Up @@ -102,7 +102,7 @@ export const presets: Record<string, Preset> = {
},
pinOnlyDevDependencies: {
description:
'Pin dependency versions for <code>devDependencies</code> and retain semver ranges for others',
'Pin dependency versions for <code>devDependencies</code> and retain SemVer ranges for others',
packageRules: [
{
matchPackagePatterns: ['*'],
Expand Down Expand Up @@ -182,7 +182,7 @@ export const presets: Record<string, Preset> = {
],
},
disableDigestUpdates: {
description: 'Disable digest and git hash updates',
description: 'Disable digest and Git hash updates',
digest: {
enabled: false,
},
Expand Down Expand Up @@ -242,11 +242,11 @@ export const presets: Record<string, Preset> = {
prHourlyLimit: 4,
},
prConcurrentLimitNone: {
description: 'Remove limit for open PRs',
description: 'Remove limit for open PRs at any time',
prConcurrentLimit: 0,
},
prConcurrentLimit10: {
description: 'Limit to maximum 10 open PRs',
description: 'Limit to maximum 10 open PRs at any time',
prConcurrentLimit: 10,
},
prConcurrentLimit20: {
Expand Down Expand Up @@ -330,7 +330,7 @@ export const presets: Record<string, Preset> = {
},
},
pinDigestsDisabled: {
description: 'Disable pinning of docker dependency digests',
description: 'Disable pinning of Docker dependency digests',
pinDigests: false,
},
maintainLockFilesWeekly: {
Expand Down Expand Up @@ -408,11 +408,12 @@ export const presets: Record<string, Preset> = {
},
},
gitSignOff: {
description: 'Append git Signed-off-by signature to git commits.',
description:
'Append Git <code>Signed-off-by:</code> signature to Git commits.',
commitBody: 'Signed-off-by: {{{gitAuthor}}}',
},
npm: {
description: 'Keep package.json npm dependencies updated',
description: 'Keep <code>package.json</code> npm dependencies updated',
npm: {
enabled: true,
},
Expand Down Expand Up @@ -517,7 +518,7 @@ export const presets: Record<string, Preset> = {
},
widenPeerDependencies: {
description:
'Always widen peerDependencies semver ranges when updating, instead of replacing',
'Always widen peerDependencies SemVer ranges when updating, instead of replacing',
packageRules: [
{
matchDepTypes: ['peerDependencies'],
Expand Down