feat(scorecard): File level checks

workspaces/scorecard/.changeset/big-yaks-say.md

@@ -0,0 +1,8 @@
+---
+'@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-github': minor
+'@red-hat-developer-hub/backstage-plugin-scorecard-backend': minor
+'@red-hat-developer-hub/backstage-plugin-scorecard-node': minor
+'@red-hat-developer-hub/backstage-plugin-scorecard': minor
+---
+
+Add support for batch metric providers, allowing a single provider to handle multiple metrics efficiently. Introduce configurable GitHub file existence checks (github.files_check.\*) that verify whether required files (like README, LICENSE, or CODEOWNERS) are present in a repository.

workspaces/scorecard/app-config.yaml

@@ -189,3 +189,11 @@ scorecard:
           frequency: { minutes: 5 }
           timeout: { minutes: 10 }
           initialDelay: { seconds: 5 }
+      files_check:
+        files:
+          - readme: 'README.md'
+          - i18guide: 'docs/backstage-i18n-guide.md'
+        schedule:
+          frequency: { minutes: 5 }
+          timeout: { minutes: 10 }
+          initialDelay: { seconds: 5 }

workspaces/scorecard/packages/app-legacy/e2e-tests/scorecard.test.ts

@@ -42,6 +42,7 @@ import {
   jiraEntitiesDrillDownResponse,
   jiraEntitiesDrillDownNoDataResponse,
   jiraMetricMetadataResponse,
+  fileCheckScorecardResponse,
 } from './utils/scorecardResponseUtils';
 import {
   ScorecardMessages,
@@ -254,6 +255,71 @@ test.describe('Scorecard Plugin Tests', () => {
 
       await runAccessibilityTests(page, testInfo);
     });
+
+    test('Verify file check metrics display correctly', async ({
+      browser,
+    }, testInfo) => {
+      await mockApiResponse(
+        page,
+        ScorecardRoutes.SCORECARD_API_ROUTE,
+        fileCheckScorecardResponse,
+      );
+
+      await catalogPage.openCatalog();
+      await catalogPage.openComponent('Red Hat Developer Hub');
+      await scorecardPage.openTab();
+
+      const existLabel = translations.thresholds.exist ?? 'Exist';
+      const missingLabel = translations.thresholds.missing ?? 'Missing';
+
+      const readmeTitle = evaluateMessage(
+        translations.metric['github.files_check'].title,
+        'readme',
+      );
+      const readmeDescription = evaluateMessage(
+        translations.metric['github.files_check'].description,
+        'readme',
+      );
+
+      const readmeCard = page
+        .locator('[role="article"]')
+        .filter({ hasText: readmeTitle })
+        .first();
+      await expect(readmeCard).toBeVisible();
+      await expect(readmeCard.getByText(readmeDescription)).toBeVisible();
+      await expect(
+        readmeCard.getByText(existLabel, { exact: true }),
+      ).toBeVisible();
+      await expect(
+        readmeCard.getByText(missingLabel, { exact: true }),
+      ).toBeVisible();
+
+      const codeownersTitle = evaluateMessage(
+        translations.metric['github.files_check'].title,
+        'codeowners',
+      );
+      const codeownersDescription = evaluateMessage(
+        translations.metric['github.files_check'].description,
+        'codeowners',
+      );
+
+      const codeownersCard = page
+        .locator('[role="article"]')
+        .filter({ hasText: codeownersTitle })
+        .first();
+      await expect(codeownersCard).toBeVisible();
+      await expect(
+        codeownersCard.getByText(codeownersDescription),
+      ).toBeVisible();
+      await expect(
+        codeownersCard.getByText(existLabel, { exact: true }),
+      ).toBeVisible();
+      await expect(
+        codeownersCard.getByText(missingLabel, { exact: true }),
+      ).toBeVisible();
+
+      await runAccessibilityTests(page, testInfo);
+    });
   });
 
   test.describe('Homepage aggregated scorecards', () => {

workspaces/scorecard/packages/app-legacy/e2e-tests/utils/scorecardResponseUtils.ts

@@ -506,3 +506,74 @@ export const jiraEntitiesDrillDownNoDataResponse = {
     isCapped: false,
   },
 };
+
+export const fileCheckScorecardResponse = [
+  {
+    id: 'github.files_check.readme',
+    status: 'success',
+    metadata: {
+      title: 'GitHub File: README.md',
+      description: 'Checks if README.md exists in the repository.',
+      type: 'boolean',
+      history: true,
+    },
+    result: {
+      value: true,
+      timestamp: '2025-09-08T09:08:55.629Z',
+      thresholdResult: {
+        definition: {
+          rules: [
+            {
+              key: 'exist',
+              expression: '==true',
+              color: 'success.main',
+              icon: 'scorecardSuccessStatusIcon',
+            },
+            {
+              key: 'missing',
+              expression: '==false',
+              color: 'error.main',
+              icon: 'scorecardErrorStatusIcon',
+            },
+          ],
+        },
+        status: 'success',
+        evaluation: 'exist',
+      },
+    },
+  },
+  {
+    id: 'github.files_check.codeowners',
+    status: 'success',
+    metadata: {
+      title: 'GitHub File: CODEOWNERS',
+      description: 'Checks if CODEOWNERS exists in the repository.',
+      type: 'boolean',
+      history: true,
+    },
+    result: {
+      value: false,
+      timestamp: '2025-09-08T09:08:55.629Z',
+      thresholdResult: {
+        definition: {
+          rules: [
+            {
+              key: 'exist',
+              expression: '==true',
+              color: 'success.main',
+              icon: 'scorecardSuccessStatusIcon',
+            },
+            {
+              key: 'missing',
+              expression: '==false',
+              color: 'error.main',
+              icon: 'scorecardErrorStatusIcon',
+            },
+          ],
+        },
+        status: 'success',
+        evaluation: 'missing',
+      },
+    },
+  },
+];

workspaces/scorecard/packages/app-legacy/src/App.tsx

@@ -217,6 +217,66 @@ const mountPoints: HomePageCardMountPoint[] = [
       },
     },
   },
+  {
+    Component: ScorecardHomepageCard as ComponentType,
+    config: {
+      id: 'scorecard-github.files_check.readme',
+      title: 'Scorecard: README file exists',
+      cardLayout: {
+        width: {
+          minColumns: 3,
+          maxColumns: 12,
+          defaultColumns: 4,
+        },
+        height: {
+          minRows: 5,
+          maxRows: 12,
+          defaultRows: 6,
+        },
+      },
+      layouts: {
+        xl: { w: 4, h: 6 },
+        lg: { w: 4, h: 6 },
+        md: { w: 4, h: 6 },
+        sm: { w: 4, h: 6 },
+        xs: { w: 4, h: 6 },
+        xxs: { w: 4, h: 6 },
+      },
+      props: {
+        aggregationId: 'github.files_check.readme',
+      },
+    },
+  },
+  {
+    Component: ScorecardHomepageCard as ComponentType,
+    config: {
+      id: 'scorecard-github.files_check.i18guide',
+      title: 'Scorecard: i18n guide file exists',
+      cardLayout: {
+        width: {
+          minColumns: 3,
+          maxColumns: 12,
+          defaultColumns: 4,
+        },
+        height: {
+          minRows: 5,
+          maxRows: 12,
+          defaultRows: 6,
+        },
+      },
+      layouts: {
+        xl: { w: 4, h: 6, x: 4 },
+        lg: { w: 4, h: 6, x: 4 },
+        md: { w: 4, h: 6, x: 4 },
+        sm: { w: 4, h: 6, x: 4 },
+        xs: { w: 4, h: 6, x: 4 },
+        xxs: { w: 4, h: 6, x: 4 },
+      },
+      props: {
+        aggregationId: 'github.files_check.i18guide',
+      },
+    },
+  },
   {
     Component: ScorecardHomepageCard as ComponentType,
     config: {
@@ -251,14 +311,24 @@ const mountPoints: HomePageCardMountPoint[] = [
               title: 'Metric (Needs currently a page reload after change!)',
               type: 'string',
               default: 'jira.open_issues',
-              enum: ['jira.open_issues', 'github.open_prs'],
+              enum: [
+                'jira.open_issues',
+                'github.open_prs',
+                'github.files_check.readme',
+                'github.files_check.i18guide',
+              ],
             },
           },
         },
         uiSchema: {
           metricId: {
             'ui:widget': 'RadioWidget',
-            'ui:enumNames': ['Jira Open Issues', 'GitHub Open PRs'],
+            'ui:enumNames': [
+              'Jira Open Issues',
+              'GitHub Open PRs',
+              'README file exists',
+              'i18n guide file exists',
+            ],
           },
         },
       },

workspaces/scorecard/plugins/scorecard-backend-module-github/README.md

@@ -85,6 +85,51 @@ This metric counts all pull requests that are currently in an "open" state for t
                 expression: '<10'
   ```
 
+### GitHub File Checks (`github.files_check.*`)
+
+This metric provider checks whether specific files exist in a repository. It's useful for enforcing best practices like having a `README.md`, `LICENSE`, `CODEOWNERS`, or other required files.
+
+- **Metric ID**: `github.files_check.<file_id>` (e.g., `github.files_check.readme`)
+- **Type**: Boolean
+- **Datasource**: `github`
+- **Default thresholds**:
+  - `success`: File exists (`==true`)
+  - `error`: File is missing (`==false`)
+
+#### Configuration
+
+To enable file checks, add a `files_check` configuration in your `app-config.yaml`:
+
+```yaml
+# app-config.yaml
+scorecard:
+  plugins:
+    github:
+      files_check:
+        files:
+          - readme: 'README.md'
+          - license: 'LICENSE'
+          - codeowners: 'CODEOWNERS'
+          - dockerfile: 'Dockerfile'
+```
+
+Each entry in the `files` array creates a separate metric:
+
+- The **key** (e.g., `readme`) becomes the metric identifier suffix (`github.files_check.readme`)
+- The **value** (e.g., `README.md`) is the file path to check in the repository
+
+#### File Path Format
+
+File paths must be relative to the repository root:
+
+| Format           | Example                | Valid |
+| ---------------- | ---------------------- | ----- |
+| Root file        | `README.md`            | ✅    |
+| Subdirectory     | `docs/CONTRIBUTING.md` | ✅    |
+| Hidden file      | `.gitignore`           | ✅    |
+| With `./` prefix | `./README.md`          | ❌    |
+| Absolute path    | `/home/file.txt`       | ❌    |
+
 ## Configuration
 
 ### Threshold Configuration
@@ -107,6 +152,16 @@ scorecard:
             minutes: 5
           initialDelay:
             seconds: 5
+      files_check:
+        files:
+          - readme: 'README.md'
+        schedule:
+          frequency:
+            cron: '0 6 * * *'
+          timeout:
+            minutes: 5
+          initialDelay:
+            seconds: 5
 ```
 
 The schedule configuration follows Backstage's `SchedulerServiceTaskScheduleDefinitionConfig` [schema](https://github.com/backstage/backstage/blob/master/packages/backend-plugin-api/src/services/definitions/SchedulerService.ts#L157).

workspaces/scorecard/plugins/scorecard-backend-module-github/config.d.ts

@@ -32,6 +32,14 @@ export interface Config {
           };
           schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
         };
+        files_check?: {
+          /** File existence checks configuration */
+          files?: Array<{
+            /** Key is the metric identifier, value is the file path */
+            [metricId: string]: string;
+          }>;
+          schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
+        };
       };
     };
   };