fix(ci): prevent overwriting report artifacts

e2e/ci-e2e/tests/basic.e2e.test.ts

@@ -46,15 +46,18 @@ describe('CI - standalone mode', () => {
       ).resolves.toEqual({
         mode: 'standalone',
         files: {
-          report: {
-            json: path.join(repo.baseDir, '.code-pushup/report.json'),
-            md: path.join(repo.baseDir, '.code-pushup/report.md'),
+          current: {
+            json: path.join(
+              repo.baseDir,
+              '.code-pushup/.ci/.current/report.json',
+            ),
+            md: path.join(repo.baseDir, '.code-pushup/.ci/.current/report.md'),
           },
         },
       } satisfies RunResult);
 
       const jsonPromise = readFile(
-        path.join(repo.baseDir, '.code-pushup/report.json'),
+        path.join(repo.baseDir, '.code-pushup/.ci/.current/report.json'),
         'utf8',
       );
       await expect(jsonPromise).resolves.toBeTruthy();
@@ -103,19 +106,35 @@ describe('CI - standalone mode', () => {
         commentId: MOCK_COMMENT.id,
         newIssues: [],
         files: {
-          report: {
-            json: path.join(repo.baseDir, '.code-pushup/report.json'),
-            md: path.join(repo.baseDir, '.code-pushup/report.md'),
+          current: {
+            json: path.join(
+              repo.baseDir,
+              '.code-pushup/.ci/.current/report.json',
+            ),
+            md: path.join(repo.baseDir, '.code-pushup/.ci/.current/report.md'),
           },
-          diff: {
-            json: path.join(repo.baseDir, '.code-pushup/report-diff.json'),
-            md: path.join(repo.baseDir, '.code-pushup/report-diff.md'),
+          previous: {
+            json: path.join(
+              repo.baseDir,
+              '.code-pushup/.ci/.previous/report.json',
+            ),
+            md: path.join(repo.baseDir, '.code-pushup/.ci/.previous/report.md'),
+          },
+          comparison: {
+            json: path.join(
+              repo.baseDir,
+              '.code-pushup/.ci/.comparison/report-diff.json',
+            ),
+            md: path.join(
+              repo.baseDir,
+              '.code-pushup/.ci/.comparison/report-diff.md',
+            ),
           },
         },
       } satisfies RunResult);
 
       const mdPromise = readFile(
-        path.join(repo.baseDir, '.code-pushup/report-diff.md'),
+        path.join(repo.baseDir, '.code-pushup/.ci/.comparison/report-diff.md'),
         'utf8',
       );
       await expect(mdPromise).resolves.toBeTruthy();

e2e/ci-e2e/tests/npm-workspaces.e2e.test.ts

@@ -52,14 +52,14 @@ describe('CI - monorepo mode (npm workspaces)', () => {
           {
             name: '@example/cli',
             files: {
-              report: {
+              current: {
                 json: path.join(
                   repo.baseDir,
-                  'packages/cli/.code-pushup/report.json',
+                  '.code-pushup/.ci/@example/cli/.current/report.json',
                 ),
                 md: path.join(
                   repo.baseDir,
-                  'packages/cli/.code-pushup/report.md',
+                  '.code-pushup/.ci/@example/cli/.current/report.md',
                 ),
               },
             },
@@ -69,7 +69,10 @@ describe('CI - monorepo mode (npm workspaces)', () => {
 
       await expect(
         readJsonFile(
-          path.join(repo.baseDir, 'packages/cli/.code-pushup/report.json'),
+          path.join(
+            repo.baseDir,
+            '.code-pushup/.ci/@example/cli/.current/report.json',
+          ),
         ),
       ).resolves.toEqual(
         expect.objectContaining({
@@ -120,29 +123,46 @@ describe('CI - monorepo mode (npm workspaces)', () => {
       await expect(runInCI(refs, MOCK_API, options, git)).resolves.toEqual({
         mode: 'monorepo',
         commentId: MOCK_COMMENT.id,
-        diffPath: path.join(repo.baseDir, '.code-pushup/merged-report-diff.md'),
+        files: {
+          comparison: {
+            md: path.join(
+              repo.baseDir,
+              '.code-pushup/.ci/.comparison/report-diff.md',
+            ),
+          },
+        },
         projects: expect.arrayContaining<ProjectRunResult>([
           {
             name: '@example/core',
             files: {
-              report: {
+              current: {
+                json: path.join(
+                  repo.baseDir,
+                  '.code-pushup/.ci/@example/core/.current/report.json',
+                ),
+                md: path.join(
+                  repo.baseDir,
+                  '.code-pushup/.ci/@example/core/.current/report.md',
+                ),
+              },
+              previous: {
                 json: path.join(
                   repo.baseDir,
-                  'packages/core/.code-pushup/report.json',
+                  '.code-pushup/.ci/@example/core/.previous/report.json',
                 ),
                 md: path.join(
                   repo.baseDir,
-                  'packages/core/.code-pushup/report.md',
+                  '.code-pushup/.ci/@example/core/.previous/report.md',
                 ),
               },
-              diff: {
+              comparison: {
                 json: path.join(
                   repo.baseDir,
-                  'packages/core/.code-pushup/report-diff.json',
+                  '.code-pushup/.ci/@example/core/.comparison/report-diff.json',
                 ),
                 md: path.join(
                   repo.baseDir,
-                  'packages/core/.code-pushup/report-diff.md',
+                  '.code-pushup/.ci/@example/core/.comparison/report-diff.md',
                 ),
               },
             },
@@ -152,7 +172,7 @@ describe('CI - monorepo mode (npm workspaces)', () => {
       } satisfies RunResult);
 
       const mdPromise = readFile(
-        path.join(repo.baseDir, '.code-pushup/merged-report-diff.md'),
+        path.join(repo.baseDir, '.code-pushup/.ci/.comparison/report-diff.md'),
         'utf8',
       );
       await expect(mdPromise).resolves.toBeTruthy();

e2e/ci-e2e/tests/nx-monorepo.e2e.test.ts

@@ -53,12 +53,15 @@ describe('CI - monorepo mode (Nx)', () => {
           {
             name: 'api',
             files: {
-              report: {
+              current: {
                 json: path.join(
                   repo.baseDir,
-                  'apps/api/.code-pushup/report.json',
+                  '.code-pushup/.ci/api/.current/report.json',
+                ),
+                md: path.join(
+                  repo.baseDir,
+                  '.code-pushup/.ci/api/.current/report.md',
                 ),
-                md: path.join(repo.baseDir, 'apps/api/.code-pushup/report.md'),
               },
             },
           },
@@ -67,7 +70,7 @@ describe('CI - monorepo mode (Nx)', () => {
 
       await expect(
         readJsonFile(
-          path.join(repo.baseDir, 'apps/api/.code-pushup/report.json'),
+          path.join(repo.baseDir, '.code-pushup/.ci/api/.current/report.json'),
         ),
       ).resolves.toEqual(
         expect.objectContaining({
@@ -85,7 +88,7 @@ describe('CI - monorepo mode (Nx)', () => {
       );
       await expect(
         readJsonFile(
-          path.join(repo.baseDir, 'libs/ui/.code-pushup/report.json'),
+          path.join(repo.baseDir, '.code-pushup/.ci/ui/.current/report.json'),
         ),
       ).resolves.toEqual(
         expect.objectContaining({
@@ -145,26 +148,46 @@ describe('CI - monorepo mode (Nx)', () => {
       await expect(runInCI(refs, MOCK_API, options, git)).resolves.toEqual({
         mode: 'monorepo',
         commentId: MOCK_COMMENT.id,
-        diffPath: path.join(repo.baseDir, '.code-pushup/merged-report-diff.md'),
+        files: {
+          comparison: {
+            md: path.join(
+              repo.baseDir,
+              '.code-pushup/.ci/.comparison/report-diff.md',
+            ),
+          },
+        },
         projects: expect.arrayContaining<ProjectRunResult>([
           {
             name: 'web',
             files: {
-              report: {
+              current: {
+                json: path.join(
+                  repo.baseDir,
+                  '.code-pushup/.ci/web/.current/report.json',
+                ),
+                md: path.join(
+                  repo.baseDir,
+                  '.code-pushup/.ci/web/.current/report.md',
+                ),
+              },
+              previous: {
                 json: path.join(
                   repo.baseDir,
-                  'apps/web/.code-pushup/report.json',
+                  '.code-pushup/.ci/web/.previous/report.json',
+                ),
+                md: path.join(
+                  repo.baseDir,
+                  '.code-pushup/.ci/web/.previous/report.md',
                 ),
-                md: path.join(repo.baseDir, 'apps/web/.code-pushup/report.md'),
               },
-              diff: {
+              comparison: {
                 json: path.join(
                   repo.baseDir,
-                  'apps/web/.code-pushup/report-diff.json',
+                  '.code-pushup/.ci/web/.comparison/report-diff.json',
                 ),
                 md: path.join(
                   repo.baseDir,
-                  'apps/web/.code-pushup/report-diff.md',
+                  '.code-pushup/.ci/web/.comparison/report-diff.md',
                 ),
               },
             },
@@ -182,7 +205,7 @@ describe('CI - monorepo mode (Nx)', () => {
       } satisfies RunResult);
 
       const mdPromise = readFile(
-        path.join(repo.baseDir, '.code-pushup/merged-report-diff.md'),
+        path.join(repo.baseDir, '.code-pushup/.ci/.comparison/report-diff.md'),
         'utf8',
       );
       await expect(mdPromise).resolves.toBeTruthy();

packages/ci/README.md

@@ -137,7 +137,7 @@ const result = await runInCI(refs, api);
 if (result.mode === 'standalone') {
   const {
     // output files, can be uploaded as job artifact
-    files: { report, diff },
+    files: { current, comparison },
     // ID of created/updated PR comment
     commentId,
     // array of source code issues, can be used to annotate changed files in PR
@@ -231,15 +231,15 @@ if (result.mode === 'monorepo') {
     // ID of created/updated PR comment
     commentId,
     // merged report-diff.md used in PR comment, can also be uploaded as job artifact
-    diffPath,
+    files: { comparison },
   } = result;
 
   for (const project of projects) {
     const {
       // detected project name (from package.json, project.json or folder name)
       name,
       // output files, can be uploaded as job artifacts
-      files: { report, diff },
+      files: { current, comparison },
       // array of source code issues, can be used to annotate changed files in PR
       newIssues,
     } = project;

packages/ci/src/lib/models.ts

@@ -94,7 +94,9 @@ export type MonorepoRunResult = {
   mode: 'monorepo';
   projects: ProjectRunResult[];
   commentId?: number;
-  diffPath?: string;
+  files?: {
+    comparison: Pick<OutputFiles, 'md'>;
+  };
 };
 
 /**
@@ -103,8 +105,9 @@ export type MonorepoRunResult = {
 export type ProjectRunResult = {
   name: string;
   files: {
-    report: OutputFiles;
-    diff?: OutputFiles;
+    current: OutputFiles;
+    previous?: OutputFiles | Pick<OutputFiles, 'json'>;
+    comparison?: OutputFiles;
   };
   newIssues?: SourceFileIssue[];
 };

packages/ci/src/lib/output-files.ts

@@ -0,0 +1,53 @@
+import { copyFile, mkdir } from 'node:fs/promises';
+import path from 'node:path';
+import { DEFAULT_PERSIST_FILENAME, type Format } from '@code-pushup/models';
+import { objectFromEntries, objectToKeys } from '@code-pushup/utils';
+import type { OutputFiles, Settings } from './models.js';
+import type { ProjectConfig } from './monorepo/tools.js';
+
+const BASE_DIR = path.join('.code-pushup', '.ci');
+
+type OutputType = 'current' | 'previous' | 'comparison';
+
+export async function saveOutputFiles<T extends Partial<OutputFiles>>({
+  project,
+  type,
+  files,
+  settings: { logger, directory },
+}: {
+  project: Pick<ProjectConfig, 'name'> | null;
+  type: OutputType;
+  files: T;
+  settings: Pick<Settings, 'logger' | 'directory'>;
+}): Promise<T> {
+  const baseDir = project ? path.join(BASE_DIR, project.name) : BASE_DIR;
+  const outputDir = path.join(directory, baseDir, `.${type}`);
+  const name =
+    type === 'comparison'
+      ? `${DEFAULT_PERSIST_FILENAME}-diff`
+      : DEFAULT_PERSIST_FILENAME;
+
+  const formats = objectToKeys(files) as Format[];
+  const outputs = objectFromEntries(
+    formats.map(format => [
+      format,
+      path.join(outputDir, `${name}.${format.toString()}`),
+    ]),
+  );
+
+  if (formats.length > 0) {
+    await mkdir(outputDir, { recursive: true });
+  }
+
+  await Promise.all(
+    formats.map(async format => {
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      const src = files[format]!;
+      const dest = outputs[format];
+      await copyFile(src, dest);
+      logger.debug(`Copied ${type} report from ${src} to ${dest}`);
+    }),
+  );
+
+  return outputs as T;
+}