From ffa7f5e68f10a54e01fd0905a54588a1f9c68071 Mon Sep 17 00:00:00 2001
From: Rhys Arkins <rhys@arkins.net>
Date: Sun, 26 Mar 2023 10:53:53 +0200
Subject: [PATCH] fix(onboarding): improve preset description resolution
(#21165)
---
lib/config/presets/__snapshots__/index.spec.ts.snap | 2 +-
lib/config/presets/internal/default.ts | 2 +-
lib/config/presets/internal/group.ts | 4 ++--
lib/config/presets/internal/replacements.ts | 3 ++-
lib/config/presets/internal/workarounds.ts | 4 ++--
5 files changed, 8 insertions(+), 7 deletions(-)
diff --git a/lib/config/presets/__snapshots__/index.spec.ts.snap b/lib/config/presets/__snapshots__/index.spec.ts.snap
index 1362f38184..e1986daa78 100644
--- a/lib/config/presets/__snapshots__/index.spec.ts.snap
+++ b/lib/config/presets/__snapshots__/index.spec.ts.snap
@@ -31,7 +31,7 @@ exports[`config/presets/index resolvePreset migrates automerge in presets 1`] =
"branchPrefix": "renovate/",
"description": [
"Prefix \`renovate/\` to all branch names.",
- "If Renovate detects semantic commits, it will use semantic commit type \`fix\` for dependencies and \`chore\` for all others.",
+ "Use semantic commit type \`fix\` for dependencies and \`chore\` for all others if semantic commits are in use.",
"Require all status checks to pass before any automerging.",
"Pin dependency versions for \`devDependencies\` and retain SemVer ranges for others.",
],
diff --git a/lib/config/presets/internal/default.ts b/lib/config/presets/internal/default.ts
index 8cef075470..0c4340b17f 100644
--- a/lib/config/presets/internal/default.ts
+++ b/lib/config/presets/internal/default.ts
@@ -525,7 +525,7 @@ export const presets: Record<string, Preset> = {
},
semanticPrefixFixDepsChoreOthers: {
description:
- 'If Renovate detects semantic commits, it will use semantic commit type `fix` for dependencies and `chore` for all others.',
+ 'Use semantic commit type `fix` for dependencies and `chore` for all others if semantic commits are in use.',
packageRules: [
{
matchPackagePatterns: ['*'],
diff --git a/lib/config/presets/internal/group.ts b/lib/config/presets/internal/group.ts
index 4e4d71da78..9fb03c9f02 100644
--- a/lib/config/presets/internal/group.ts
+++ b/lib/config/presets/internal/group.ts
@@ -398,7 +398,7 @@ const staticGroups = {
'group:springWs',
'group:symfony',
],
- ignoreDeps: [],
+ ignoreDeps: [], // Hack to improve onboarding PR description
},
resilience4j: {
description: 'Group Java Resilience4j packages.',
@@ -730,7 +730,7 @@ for (const monorepo of Object.keys(monorepos.presets)) {
config.monorepos = {
description: 'Group known monorepo packages together.',
extends: monorepoNames,
- ignoreDeps: [],
+ ignoreDeps: [], // Hack to improve onboarding PR description
};
export const presets: Record<string, Preset> = config;
diff --git a/lib/config/presets/internal/replacements.ts b/lib/config/presets/internal/replacements.ts
index 414220a60a..47428ab9da 100644
--- a/lib/config/presets/internal/replacements.ts
+++ b/lib/config/presets/internal/replacements.ts
@@ -10,7 +10,7 @@ import {
/* eslint sort-keys: ["error", "asc", {"caseSensitive": false, "natural": true}] */
export const presets: Record<string, Preset> = {
all: {
- description: 'All replacements.',
+ description: 'Apply crowd-sourced package replacement rules.',
extends: [
'replacements:apollo-server-to-scoped',
'replacements:babel-eslint-to-eslint-parser',
@@ -34,6 +34,7 @@ export const presets: Record<string, Preset> = {
'replacements:vsts-task-lib-to-azure-pipelines-task-lib',
'replacements:xmldom-to-scoped',
],
+ ignoreDeps: [], // Hack to improve onboarding PR description
},
'apollo-server-to-scoped': {
description: '`apollo-server` packages became scoped.',
diff --git a/lib/config/presets/internal/workarounds.ts b/lib/config/presets/internal/workarounds.ts
index b7149d9505..ef23bd7144 100644
--- a/lib/config/presets/internal/workarounds.ts
+++ b/lib/config/presets/internal/workarounds.ts
@@ -5,7 +5,7 @@ import type { Preset } from '../types';
export const presets: Record<string, Preset> = {
all: {
description: [
- 'A collection of workarounds for known problems with packages.',
+ 'Apply crowd-sourced workarounds for known problems with packages.',
],
extends: [
'workarounds:mavenCommonsAncientVersion',
@@ -20,7 +20,7 @@ export const presets: Record<string, Preset> = {
'workarounds:disableMavenParentRoot',
'workarounds:containerbase',
],
- ignoreDeps: [],
+ ignoreDeps: [], // Hack to improve onboarding PR description
},
containerbase: {
description: 'Add some containerbase overrides',
--
GitLab