chore: add monorepo mode to repository

.github/workflows/code-pushup-fork.yml → .github/workflows/code-pushup-fork.centralized.yml

@@ -1,4 +1,4 @@
-name: Code PushUp (fork)
+name: Code PushUp - Standalone Mode (fork)
 
 # separated from code-pushup.yml for security reasons
 # => requires permissions to create PR comment
@@ -20,19 +20,23 @@ permissions:
 jobs:
   code-pushup:
     runs-on: ubuntu-latest
-    name: Code PushUp
+    name: Run Code PushUp (fork)
     if: github.event.pull_request.head.repo.fork
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
           node-version-file: .nvmrc
           cache: npm
+      - name: Set base and head for Nx affected commands
+        uses: nrwl/nx-set-shas@v4
       - name: Install dependencies
         run: npm ci
       - name: Run Code PushUp action
         uses: code-pushup/github-action@v0
         with:
-          bin: npx nx code-pushup --
+          bin: npx nx code-pushup --nx-bail  --

.github/workflows/code-pushup-fork.monorepo.yml

@@ -0,0 +1,44 @@
+name: Code PushUp - Monorepo/Cache (fork)
+
+# separated from code-pushup.yml for security reasons
+# => requires permissions to create PR comment
+# => for PRs from forks, needs to run on `pull_request_target`, not `pull_request`
+# => `pull_request_target` is a security risk when secrets are being used
+# => secrets needed for code-pushup upload
+# => code-pushup for forks runs in separate workflow with no secrets access
+
+on:
+  pull_request_target:
+    branches: [main]
+
+env:
+  NX_NON_NATIVE_HASHER: true
+
+permissions:
+  pull-requests: write
+
+jobs:
+  code-pushup:
+    runs-on: ubuntu-latest
+    name: Run monorepo layout with caching
+    if: github.event.pull_request.head.repo.fork
+    steps:
+      - name: Checkout PR head
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          ref: ${{ github.event.pull_request.head.ref }}
+          fetch-depth: 0
+      - name: Derive Nx SHAs
+        uses: nrwl/nx-set-shas@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Run Code PushUp action
+        uses: code-pushup/github-action@v0
+        with:
+          bin: npx nx affected -t code-pushup --

.github/workflows/code-pushup.yml → .github/workflows/code-pushup.centralized.yml

@@ -1,4 +1,4 @@
-name: Code PushUp
+name: Code PushUp - Standalone Mode
 
 on:
   push:
@@ -16,7 +16,7 @@ permissions:
 jobs:
   code-pushup:
     runs-on: ubuntu-latest
-    name: Code PushUp
+    name: Run Code PushUp
     # ignore PRs from forks, handled by code-pushup-fork.yml
     if: ${{ !github.event.pull_request.head.repo.fork }}
     env:
@@ -27,14 +27,18 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
           node-version-file: .nvmrc
           cache: npm
+      - name: Set base and head for Nx affected commands
+        uses: nrwl/nx-set-shas@v4
       - name: Install dependencies
         run: npm ci
       - name: Run Code PushUp action
         uses: code-pushup/github-action@v0
         with:
-          bin: npx nx code-pushup --
+          bin: npx nx code-pushup --nx-bail  --

.github/workflows/code-pushup.monorepo.yml

@@ -0,0 +1,45 @@
+name: Code PushUp - Monorepo/Cache
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+env:
+  NX_NON_NATIVE_HASHER: true
+
+permissions:
+  pull-requests: write
+
+jobs:
+  code-pushup:
+    runs-on: ubuntu-latest
+    name: Run monorepo layout with caching
+    # ignore PRs from forks, handled by code-pushup-fork.yml
+    if: ${{ !github.event.pull_request.head.repo.fork }}
+    env:
+      CP_SERVER: ${{ secrets.CP_SERVER }}
+      CP_API_KEY: ${{ secrets.CP_API_KEY }}
+      CP_ORGANIZATION: code-pushup
+      CP_PROJECT: cli
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Derive Nx SHAs
+        uses: nrwl/nx-set-shas@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Run Code PushUp action
+        uses: code-pushup/github-action@v0
+        with:
+          bin: npx nx affected -t code-pushup --
+          monorepo: nx
+          parallel: 3

.prettierignore

@@ -3,3 +3,6 @@
 /coverage
 /.nx
 __snapshots__
+
+/.nx/cache
+/.nx/workspace-data

CONTRIBUTING.md

@@ -69,6 +69,41 @@ You can control the execution of long-running tests over the `INCLUDE_SLOW_TESTS
 To change this setup, open (or create) the `.env` file in the root folder.
 Edit or add the environment variable there as follows: `INCLUDE_SLOW_TESTS=true`.
 
+### Testing with pkg-new
+
+You can test the CLI using published packages from pull requests via [pkg-new](https://pkg.pr.new/). This is useful for testing changes before they are merged.
+
+To test a specific PR (replace `<PR_NUMBER>` with the actual PR number):
+
+```bash
+# Install required dependencies first
+npm install \
+  https://pkg.pr.new/code-pushup/cli/@code-pushup/utils@<PR_NUMBER> \
+  https://pkg.pr.new/code-pushup/cli/@code-pushup/models@<PR_NUMBER> \
+  https://pkg.pr.new/code-pushup/cli/@code-pushup/core@<PR_NUMBER> \
+  https://pkg.pr.new/code-pushup/cli/@code-pushup/cli@<PR_NUMBER>
+```
+
+Update nx.json to use pkg-new:
+
+```jsonc
+{
+  "targetDefaults": {
+    "code-pushup": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "npx https://pkg.pr.new/code-pushup/cli/@code-pushup/cli@<PR_NUMBER>", // instead of "command": "node packages/cli/src/index.ts"
+        "args": [
+          // ...
+        ],
+      },
+    },
+  },
+}
+```
+
+**Note:** The `@code-pushup/portal-client` package may not be available via pkg-new, but it's an optional peer dependency and won't affect collect functionality. Only the upload command is not working.
+
 ## Git
 
 Commit messages must follow [conventional commits](https://conventionalcommits.org/) format.

code-pushup.central.config.ts

@@ -0,0 +1,46 @@
+import 'dotenv/config';
+import {
+  coverageCoreConfigNx,
+  eslintCoreConfigNx,
+  jsDocsCoreConfig,
+  jsPackagesCoreConfig,
+  lighthouseCoreConfig,
+  loadEnv,
+  typescriptPluginConfig,
+} from './code-pushup.preset.js';
+import type { CoreConfig } from './packages/models/src/index.js';
+import { mergeConfigs } from './packages/utils/src/index.js';
+
+const config: CoreConfig = {
+  ...(await loadEnv()),
+  plugins: [],
+};
+
+const merged = mergeConfigs(
+  config,
+  await coverageCoreConfigNx('cli'),
+  await jsPackagesCoreConfig(),
+  await lighthouseCoreConfig(
+    'https://github.com/code-pushup/cli?tab=readme-ov-file#code-pushup-cli/',
+  ),
+  await typescriptPluginConfig({
+    tsconfig: 'packages/cli/tsconfig.lib.json',
+  }),
+
+  await eslintCoreConfigNx(),
+  jsDocsCoreConfig([
+    'packages/**/src/**/*.ts',
+    '!packages/**/node_modules',
+    '!packages/**/{mocks,mock}',
+    '!**/*.{spec,test}.ts',
+    '!**/implementation/**',
+    '!**/internal/**',
+  ]),
+);
+
+export default {
+  ...merged,
+  categories: merged.categories?.filter(
+    c => c.slug !== 'bug-prevention' && c.slug !== 'code-style',
+  ),
+} satisfies CoreConfig;

code-pushup.config.ts

@@ -1,55 +1,29 @@
 import 'dotenv/config';
-import { z } from 'zod';
 import {
-  coverageCoreConfigNx,
-  eslintCoreConfigNx,
-  jsDocsCoreConfig,
   jsPackagesCoreConfig,
   lighthouseCoreConfig,
-  typescriptPluginConfig,
 } from './code-pushup.preset.js';
 import type { CoreConfig } from './packages/models/src/index.js';
 import { mergeConfigs } from './packages/utils/src/index.js';
 
-// load upload configuration from environment
-const envSchema = z.object({
-  CP_SERVER: z.string().url(),
-  CP_API_KEY: z.string().min(1),
-  CP_ORGANIZATION: z.string().min(1),
-  CP_PROJECT: z.string().min(1),
-});
-const { data: env } = await envSchema.safeParseAsync(process.env);
+const project = process.env['NX_TASK_TARGET_PROJECT'] || 'cli-workspace';
 
 const config: CoreConfig = {
-  ...(env && {
+  ...(process.env['CP_API_KEY'] && {
     upload: {
-      server: env.CP_SERVER,
-      apiKey: env.CP_API_KEY,
-      organization: env.CP_ORGANIZATION,
-      project: 'cli-workspace',
+      project,
+      organization: 'code-pushup',
+      server: 'https://api.staging.code-pushup.dev/graphql',
+      apiKey: process.env['CP_API_KEY'],
     },
   }),
-
   plugins: [],
 };
 
 export default mergeConfigs(
   config,
-  await coverageCoreConfigNx(),
   await jsPackagesCoreConfig(),
   await lighthouseCoreConfig(
     'https://github.com/code-pushup/cli?tab=readme-ov-file#code-pushup-cli/',
   ),
-  await typescriptPluginConfig({
-    tsconfig: 'packages/cli/tsconfig.lib.json',
-  }),
-  await eslintCoreConfigNx(),
-  jsDocsCoreConfig([
-    'packages/**/src/**/*.ts',
-    '!packages/**/node_modules',
-    '!packages/**/{mocks,mock}',
-    '!**/*.{spec,test}.ts',
-    '!**/implementation/**',
-    '!**/internal/**',
-  ]),
 );