feat(config): custom status checks

docs/usage/configuration-options.md

@@ -3564,6 +3564,23 @@ Configure this to `true` if you wish to get one PR for every separate major vers
 e.g. if you are on webpack@v1 currently then default behavior is a PR for upgrading to webpack@v3 and not for webpack@v2.
 If this setting is true then you would get one PR for webpack@v2 and one for webpack@v3.
 
+## statusCheckNames
+
+This feature allows users to customize the context of the staus checks added by Renovate to the update branches.
+
+1. You can modify existing status checks, but adding entirely new ones is not supported
+2. Setting the value to `null` or an empty string, will effectively disable/skip that particular status check
+3. This option is mergeable, meaning you only have to specify the status checks you want to modify
+
+```json
+{
+  "statusCheckNames": {
+    "minimumReleaseAge": "custom/stability-days",
+    "mergeConfidence": "custom/merge-confidence-level"
+  }
+}
+```
+
 ## stopUpdatingLabel
 
 This feature only works on supported platforms, check the table above.

lib/config/options/index.ts

@@ -170,6 +170,18 @@ const options: RenovateOptions[] = [
       type: 'string',
     },
   },
+  {
+    name: 'statusCheckNames',
+    description: 'Custom strings to use as status check names',
+    type: 'object',
+    mergeable: true,
+    default: {
+      minimumReleaseAge: 'renovate/stability-days',
+      mergeConfidence: 'renovate/merge-confidence',
+      configValidation: 'renovate/config-validation',
+      artifactError: 'renovate/artifacts',
+    },
+  },
   {
     name: 'extends',
     description: 'Configuration presets to use or extend.',

lib/config/types.ts

@@ -260,6 +260,8 @@ export interface RenovateConfig
 
   checkedBranches?: string[];
   customizeDashboard?: Record<string, string>;
+
+  statusCheckNames?: Record<string, string>;
 }
 
 export interface CustomDatasourceConfig {

lib/config/validation.spec.ts

@@ -144,6 +144,28 @@ describe('config/validation', () => {
       ]);
     });
 
+    it('validates invalid statusCheckNames', async () => {
+      const config = {
+        statusCheckNames: {
+          randomKey: '',
+          mergeConfidence: 10,
+          configValidation: '',
+          artifactError: null,
+        },
+      } as any;
+      const { errors } = await configValidation.validateConfig(config);
+      expect(errors).toMatchObject([
+        {
+          message:
+            'Invalid `statusCheckNames.mergeConfidence` configuration: status check is not a string',
+        },
+        {
+          message:
+            'Invalid `statusCheckNames.statusCheckNames.randomKey` configuration: key is not allowed',
+        },
+      ]);
+    });
+
     it('catches invalid customDatasources record type', async () => {
       const config = {
         customDatasources: {

lib/config/validation.ts

@@ -562,6 +562,32 @@ export async function validateConfig(
                   message: `Invalid \`${currentPath}.${key}.${res}\` configuration: value is not a string`,
                 });
               }
+            } else if (key === 'statusCheckNames') {
+              const allowedStatusStrings = [
+                'minimumReleaseAge',
+                'artifactError',
+                'mergeConfidence',
+                'configValidation',
+              ];
+              for (const [statusCheckKey, statusCheckValue] of Object.entries(
+                val,
+              )) {
+                if (!allowedStatusStrings.includes(statusCheckKey)) {
+                  errors.push({
+                    topic: 'Configuration Error',
+                    message: `Invalid \`${currentPath}.${key}.${statusCheckKey}\` configuration: key is not allowed`,
+                  });
+                }
+                if (
+                  !(is.string(statusCheckValue) || is.null_(statusCheckValue))
+                ) {
+                  errors.push({
+                    topic: 'Configuration Error',
+                    message: `Invalid \`${currentPath}.${statusCheckKey}\` configuration: status check is not a string`,
+                  });
+                  continue;
+                }
+              }
             } else if (key === 'customDatasources') {
               const allowedKeys = [
                 'description',

lib/workers/repository/reconfigure/index.spec.ts

@@ -26,6 +26,9 @@ describe('workers/repository/reconfigure/index', () => {
   const config: RenovateConfig = {
     branchPrefix: 'prefix/',
     baseBranch: 'base',
+    statusCheckNames: {
+      configValidation: 'renovate/config-validation',
+    },
   };
 
   beforeEach(() => {

lib/workers/repository/reconfigure/index.ts

@@ -16,14 +16,32 @@
   setReconfigureBranchCache,
 } from './reconfigure-cache';
 
+async function setBranchStatus(
+  branchName: string,
+  description: string,
+  state: string,
+  context: string | undefined,
+): Promise<void> {
+  if (!is.nonEmptyString(context)) {
+    return;
+  }
+
+  await platform.setBranchStatus({
+    branchName,
+    context,
+    description,
+    state: state as any,
+  });
+}
+
 export function getReconfigureBranchName(prefix: string): string {
   return `${prefix}reconfigure`;
 }
 export async function validateReconfigureBranch(
   config: RenovateConfig,
 ): Promise<void> {
   logger.debug('validateReconfigureBranch()');
-  const context = `renovate/config-validation`;
+  const context = config.statusCheckNames?.configValidation;
 
   const branchName = getReconfigureBranchName(config.branchPrefix!);
   const branchExists = await scm.branchExists(branchName);
@@ -48,14 +66,17 @@
     return;
   }
 
-  const validationStatus = await platform.getBranchStatusCheck(
-    branchName,
-    'renovate/config-validation',
-  );
-  // if old status check is present skip validation
-  if (is.nonEmptyString(validationStatus)) {
-    logger.debug('Skipping validation check as status check already exists');
-    return;
+  if (context) {
+    const validationStatus = await platform.getBranchStatusCheck(
+      branchName,
+      context,
+    );
+
+    // if old status check is present skip validation
+    if (is.nonEmptyString(validationStatus)) {
+      logger.debug('Skipping validation check as status check already exists');
+      return;
+    }
   }
 
   try {
@@ -70,12 +91,12 @@
 
   if (!is.nonEmptyString(configFileName)) {
     logger.warn('No config file found in reconfigure branch');
-    await platform.setBranchStatus({
+    await setBranchStatus(
       branchName,
+      'Validation Failed - No config file found',
+      'red',
       context,
-      description: 'Validation Failed - No config file found',
-      state: 'red',
-    });
+    );
     setReconfigureBranchCache(branchSha, false);
     await scm.checkoutBranch(config.defaultBranch!);
     return;
@@ -90,12 +111,12 @@
 
   if (!is.nonEmptyString(configFileRaw)) {
     logger.warn('Empty or invalid config file');
-    await platform.setBranchStatus({
+    await setBranchStatus(
       branchName,
+      'Validation Failed - Empty/Invalid config file',
+      'red',
       context,
-      description: 'Validation Failed - Empty/Invalid config file',
-      state: 'red',
-    });
+    );
     setReconfigureBranchCache(branchSha, false);
     await scm.checkoutBranch(config.baseBranch!);
     return;
@@ -110,12 +131,12 @@
     }
   } catch (err) {
     logger.error({ err }, 'Error while parsing config file');
-    await platform.setBranchStatus({
+    await setBranchStatus(
       branchName,
+      'Validation Failed - Unparsable config file',
+      'red',
       context,
-      description: 'Validation Failed - Unparsable config file',
-      state: 'red',
-    });
+    );
     setReconfigureBranchCache(branchSha, false);
     await scm.checkoutBranch(config.baseBranch!);
     return;
@@ -150,24 +171,14 @@
         content: body,
       });
     }
-    await platform.setBranchStatus({
-      branchName,
-      context,
-      description: 'Validation Failed',
-      state: 'red',
-    });
+    await setBranchStatus(branchName, 'Validation Failed', 'red', context);
     setReconfigureBranchCache(branchSha, false);
     await scm.checkoutBranch(config.baseBranch!);
     return;
   }
 
   // passing check
-  await platform.setBranchStatus({
-    branchName,
-    context,
-    description: 'Validation Successful',
-    state: 'green',
-  });
+  await setBranchStatus(branchName, 'Validation Successful', 'green', context);
 
   setReconfigureBranchCache(branchSha, true);
   await scm.checkoutBranch(config.baseBranch!);

lib/workers/repository/update/branch/artifacts.spec.ts

@@ -14,6 +14,9 @@ describe('workers/repository/update/branch/artifacts', () => {
       branchName: 'renovate/pin',
       upgrades: [],
       artifactErrors: [{ lockFile: 'some' }],
+      statusCheckNames: {
+        artifactError: 'renovate/artifact',
+      },
     } satisfies BranchConfig;
   });
 

lib/workers/repository/update/branch/artifacts.ts

@@ -1,3 +1,4 @@
+import is from '@sindresorhus/is';
 import { GlobalConfig } from '../../../../config/global';
 import { logger } from '../../../../logger';
 import { platform } from '../../../../modules/platform';
@@ -6,12 +7,15 @@
 export async function setArtifactErrorStatus(
   config: BranchConfig,
 ): Promise<void> {
-  if (!config.artifactErrors?.length) {
+  if (
+    !config.artifactErrors?.length ||
+    !is.nonEmptyString(config.statusCheckNames?.artifactError)
+  ) {
     // no errors
     return;
   }
 
-  const context = `renovate/artifacts`;
+  const context = config.statusCheckNames!.artifactError;
   const description = 'Artifact file update failure';
   const state = 'red';
   const existingState = await platform.getBranchStatusCheck(

lib/workers/repository/update/branch/status-checks.spec.ts

@@ -14,6 +14,9 @@ describe('workers/repository/update/branch/status-checks', () => {
     beforeEach(() => {
       config = partial<StabilityConfig>({
         branchName: 'renovate/some-branch',
+        statusCheckNames: {
+          minimumReleaseAge: 'renovate/stability-days',
+        },
       });
     });
 
@@ -53,6 +56,9 @@ describe('workers/repository/update/branch/status-checks', () => {
     beforeEach(() => {
       config = {
         branchName: 'renovate/some-branch',
+        statusCheckNames: {
+          mergeConfidence: 'renovate/merge-confidence',
+        },
       };
     });
 

lib/workers/repository/update/branch/status-checks.ts

@@ -1,3 +1,4 @@
+import is from '@sindresorhus/is';
 import type { RenovateConfig } from '../../../../config/types';
 import { logger } from '../../../../logger';
 import { platform } from '../../../../modules/platform';
@@ -59,10 +60,14 @@
 }
 
 export async function setStability(config: StabilityConfig): Promise<void> {
-  if (!config.stabilityStatus) {
+  if (
+    !config.stabilityStatus ||
+    !is.nonEmptyString(config.statusCheckNames?.minimumReleaseAge)
+  ) {
     return;
   }
-  const context = `renovate/stability-days`;
+
+  const context = config.statusCheckNames!.minimumReleaseAge;
   const description =
     config.stabilityStatus === 'green'
       ? 'Updates have met minimum release age requirement'
@@ -85,12 +90,13 @@
   if (
     !config.branchName ||
     !config.confidenceStatus ||
+    !is.nonEmptyString(config.statusCheckNames?.mergeConfidence) ||
     (config.minimumConfidence &&
       !isActiveConfidenceLevel(config.minimumConfidence))
   ) {
     return;
   }
-  const context = `renovate/merge-confidence`;
+  const context = config.statusCheckNames!.mergeConfidence;
   const description =
     config.confidenceStatus === 'green'
       ? 'Updates have met Merge Confidence requirement'