ci: setup code-pushup to measure conformance progress (#112)

BioPhoton · web-flow · commit 7175f5aefe85 · 2025-02-27T19:48:38.000+01:00
diff --git a/.github/workflows/code-pushup.yml b/.github/workflows/code-pushup.yml
@@ -0,0 +1,38 @@
+name: Code PushUp
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+  actions: read
+  pull-requests: write
+
+jobs:
+  code-pushup:
+    runs-on: ubuntu-latest
+    name: Code PushUp
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+
+      - name: Install dependencies
+        run: pnpm i --frozen-lockfile
+
+      - uses: nrwl/nx-set-shas@v4
+
+      - name: Collect Code PushUp report
+        uses: code-pushup/github-action@v0.6.0
+        env:
+          NX_NO_CLOUD: true
+          CP_API_KEY: ${{ secrets.CP_API_KEY }}
+          ACTIONS_STEP_DEBUG: true
+        with:
+          monorepo: nx
+          retention: 14
diff --git a/code-pushup.config.ts b/code-pushup.config.ts
@@ -0,0 +1,8 @@
+import { CoreConfig } from '@code-pushup/models';
+import { mergeConfigs } from '@code-pushup/utils';
+import {
+  baseConfig,
+  eslintConfig,
+} from './tools/reports/code-pushup.preset.config';
+
+export default mergeConfigs(baseConfig as CoreConfig, await eslintConfig());
diff --git a/nx.json b/nx.json
@@ -46,6 +46,13 @@
         "max-warnings": 0
       }
     },
+    "code-pushup": {
+      "command": "code-pushup",
+      "options": {
+        "config": "{projectRoot}/code-pushup.config.ts",
+        "persist.outputDir": ".code-pushup/{projectName}"
+      }
+    },
     "integration-test": {
       "cache": true,
       "options": {
diff --git a/package.json b/package.json
@@ -45,8 +45,8 @@
     "@nx/workspace": "20.3.0",
     "@playwright/test": "^1.36.0",
     "@rsbuild/core": "^1.1.12",
-    "@rsbuild/plugin-sass": "^1.1.2",
     "@rsbuild/plugin-less": "^1.1.1",
+    "@rsbuild/plugin-sass": "^1.1.2",
     "@rspack/cli": "^1.1.8",
     "@rspack/core": "^1.1.8",
     "@rspack/dev-server": "1.0.9",
@@ -64,7 +64,7 @@
     "@vitest/coverage-v8": "^1.0.4",
     "@vitest/ui": "^1.3.1",
     "angular-eslint": "^19.0.2",
-    "commitlint-plugin-tense": "^1.0.4",
+    "commitlint-plugin-tense": "1.0.4",
     "eslint": "^9.8.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-playwright": "^1.6.2",
@@ -106,10 +106,11 @@
     "@angular/platform-server": "19.1.6",
     "@angular/router": "19.1.6",
     "@angular/ssr": "19.1.6",
-    "@code-pushup/cli": "^0.59.0",
-    "@code-pushup/eslint-plugin": "^0.59.0",
-    "@code-pushup/models": "^0.59.0",
-    "@code-pushup/utils": "^0.59.0",
+    "@code-pushup/cli": "^0.63.0",
+    "@code-pushup/eslint-plugin": "^0.63.0",
+    "@code-pushup/models": "^0.63.0",
+    "@code-pushup/portal-client": "0.11.0",
+    "@code-pushup/utils": "^0.63.0",
     "@commitlint/config-nx-scopes": "^19.5.0",
     "@netlify/functions": "^3.0.0",
     "@nx/devkit": "20.3.0",
diff --git a/packages/build/code-pushup.config.ts b/packages/build/code-pushup.config.ts
@@ -0,0 +1,8 @@
+import { CoreConfig } from '@code-pushup/models';
+import { mergeConfigs } from '@code-pushup/utils';
+import {
+  baseConfig,
+  eslintConfig,
+} from '../../tools/reports/code-pushup.preset.config';
+
+export default mergeConfigs(baseConfig as CoreConfig, await eslintConfig());
diff --git a/packages/build/package.json b/packages/build/package.json
@@ -64,6 +64,8 @@
     "name": "build",
     "sourceRoot": "packages/build/src",
     "projectType": "library",
-    "targets": {}
+    "targets": {
+      "code-pushup": {}
+    }
   }
 }
diff --git a/packages/compiler/code-pushup.config.ts b/packages/compiler/code-pushup.config.ts
@@ -0,0 +1,8 @@
+import { CoreConfig } from '@code-pushup/models';
+import { mergeConfigs } from '@code-pushup/utils';
+import {
+  baseConfig,
+  eslintConfig,
+} from '../../tools/reports/code-pushup.preset.config';
+
+export default mergeConfigs(baseConfig as CoreConfig, await eslintConfig());
diff --git a/packages/compiler/package.json b/packages/compiler/package.json
@@ -52,6 +52,7 @@
     "projectType": "library",
     "name": "compiler",
     "targets": {
+      "code-pushup": {},
       "integration-test": {
         "configName": "vitest.integration.config.mts"
       },
diff --git a/packages/nx-plugin/code-pushup.config.ts b/packages/nx-plugin/code-pushup.config.ts
@@ -0,0 +1,8 @@
+import { CoreConfig } from '@code-pushup/models';
+import { mergeConfigs } from '@code-pushup/utils';
+import {
+  baseConfig,
+  eslintConfig,
+} from '../../tools/reports/code-pushup.preset.config';
+
+export default mergeConfigs(baseConfig as CoreConfig, await eslintConfig());
diff --git a/packages/nx-plugin/package.json b/packages/nx-plugin/package.json
@@ -41,8 +41,9 @@
   "nx": {
     "sourceRoot": "packages/nx-plugin/src",
     "projectType": "library",
-    "name": "nx",
+    "name": "nx-plugin",
     "targets": {
+      "code-pushup": {},
       "integration-test": {
         "options": {
           "config": "vitest.integration.config.mts"
diff --git a/packages/nx-plugin/vitest.config.mts b/packages/nx-plugin/vitest.config.mts
@@ -2,7 +2,7 @@ import { defineConfig } from 'vitest/config';
 import { resolve } from 'path';
 
 export default defineConfig({
-  cacheDir: '../../node_modules/.vite/nx/unit',
+  cacheDir: '../../node_modules/.vite/nx-plugin/unit',
   root: __dirname,
   plugins: [],
   resolve: {
@@ -14,7 +14,7 @@ export default defineConfig({
     coverage: {
       provider: 'v8',
       reporter: ['text', 'lcov'],
-      reportsDirectory: '../../coverage/nx/unit',
+      reportsDirectory: '../../coverage/nx-plugin/unit',
       exclude: ['mocks/**', '**/types.ts', '**/__snapshots__/**'],
     },
     watch: false,
diff --git a/packages/nx-plugin/vitest.integration.config.mts b/packages/nx-plugin/vitest.integration.config.mts
@@ -2,7 +2,7 @@ import { defineConfig } from 'vitest/config';
 import { resolve } from 'path';
 
 export default defineConfig({
-  cacheDir: '../../node_modules/.vite/nx/integration',
+  cacheDir: '../../node_modules/.vite/nx-plugin/integration',
   root: __dirname,
   plugins: [],
   resolve: {
@@ -14,7 +14,7 @@ export default defineConfig({
     coverage: {
       provider: 'v8',
       reporter: ['text', 'lcov'],
-      reportsDirectory: '../../coverage/nx/integration',
+      reportsDirectory: '../../coverage/nx-plugin/integration',
       exclude: ['mocks/**', '**/types.ts', '**/__snapshots__/**'],
     },
     watch: false,
diff --git a/packages/rsbuild-plugin-angular/code-pushup.config.ts b/packages/rsbuild-plugin-angular/code-pushup.config.ts
@@ -1,29 +1,8 @@
 import { CoreConfig } from '@code-pushup/models';
-import eslintPlugin, {
-  eslintConfigFromNxProject,
-} from '@code-pushup/eslint-plugin';
+import { mergeConfigs } from '@code-pushup/utils';
+import {
+  baseConfig,
+  eslintConfig,
+} from '../../tools/reports/code-pushup.preset.config';
 
-export default {
-  plugins: [
-    await eslintPlugin(
-      await eslintConfigFromNxProject('rsbuild-plugin-angular')
-    ),
-  ],
-  categories: [
-    {
-      slug: 'bug-prevention',
-      title: 'Bug prevention',
-      description: 'Lint rules that find **potential bugs** in your code.',
-      refs: [{ type: 'group', plugin: 'eslint', slug: 'problems', weight: 1 }],
-    },
-    {
-      slug: 'code-style',
-      title: 'Code style',
-      description:
-        'Lint rules that promote **good practices** and consistency in your code.',
-      refs: [
-        { type: 'group', plugin: 'eslint', slug: 'suggestions', weight: 1 },
-      ],
-    },
-  ],
-} satisfies CoreConfig;
+export default mergeConfigs(baseConfig as CoreConfig, await eslintConfig());
diff --git a/packages/rsbuild-plugin-angular/package.json b/packages/rsbuild-plugin-angular/package.json
@@ -60,13 +60,7 @@
           "^build"
         ]
       },
-      "cp": {
-        "command": "pnpx @code-pushup/cli collect",
-        "options": {
-          "persist.outputDir": ".code-pushup/{projectName}",
-          "config": "{projectRoot}/code-pushup.config.ts"
-        }
-      }
+      "code-pushup": {}
     }
   }
 }
diff --git a/packages/rsbuild-plugin-nx/code-pushup.config.ts b/packages/rsbuild-plugin-nx/code-pushup.config.ts
@@ -0,0 +1,8 @@
+import { CoreConfig } from '@code-pushup/models';
+import { mergeConfigs } from '@code-pushup/utils';
+import {
+  baseConfig,
+  eslintConfig,
+} from '../../tools/reports/code-pushup.preset.config';
+
+export default mergeConfigs(baseConfig as CoreConfig, await eslintConfig());
diff --git a/packages/rsbuild-plugin-nx/package.json b/packages/rsbuild-plugin-nx/package.json
@@ -42,6 +42,9 @@
   "nx": {
     "sourceRoot": "packages/rsbuild-plugin-nx/src",
     "projectType": "library",
-    "name": "rsbuild-plugin-nx"
+    "name": "rsbuild-plugin-nx",
+    "targets": {
+      "code-pushup": {}
+    }
   }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tools/eslint-rules/rules/vitest-config-has-test-coverage-configured.ts b/tools/eslint-rules/rules/vitest-config-has-test-coverage-configured.ts
diff --git a/tools/eslint-rules/rules/vitest-config-has-unique-cachedir-configured.ts b/tools/eslint-rules/rules/vitest-config-has-unique-cachedir-configured.ts
diff --git a/tools/eslint-rules/utils/constants.ts b/tools/eslint-rules/utils/constants.ts
diff --git a/tools/reports/code-pushup.preset.config.ts b/tools/reports/code-pushup.preset.config.ts

Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,8 @@`
`64`	`64`	`"name": "build",`
`65`	`65`	`"sourceRoot": "packages/build/src",`
`66`	`66`	`"projectType": "library",`
`67`		`- "targets": {}`
	`67`	`+ "targets": {`
	`68`	`+ "code-pushup": {}`
	`69`	`+ }`
`68`	`70`	`}`
`69`	`71`	`}`