@code-pushup/ci 0.53.0 → 0.54.0

package/README.md

@@ -14,10 +14,10 @@
 
 This package exports **provider-agnostic core logic for running Code PushUp in CI pipelines**. It serves as the base for the following provider integrations:
 
-|                |                                                                                   |
-| :------------- | :-------------------------------------------------------------------------------- |
-| GitHub Actions | [`code-pushup/github-action`](https://github.com/marketplace/actions/code-pushup) |
-| GitLab CI/CD   | _coming soon_                                                                     |
+|                |                                                                                                     |
+| :------------- | :-------------------------------------------------------------------------------------------------- |
+| GitHub Actions | [`code-pushup/github-action`](https://github.com/marketplace/actions/code-pushup)                   |
+| GitLab CI/CD   | [`code-pushup/gitlab-pipelines-template`](https://gitlab.com/code-pushup/gitlab-pipelines-template) |
 
 ## Setup
 
@@ -74,13 +74,13 @@ This will additionally compare reports from both source and target branches and
 The PR flow requires interacting with the Git provider's API to post a comparison comment.
 Wrap these requests in functions and pass them in as an object which configures the provider.
 
-| Property                 | Required | Type                                             | Description                                                                                                              |
-| :----------------------- | :------: | :----------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------- |
-| `createComment`          |   yes    | `(body: string) => Promise<Comment>`             | Posts a new comment to PR                                                                                                |
-| `updateComment`          |   yes    | `(id: number, body: string) => Promise<Comment>` | Updates existing PR comment                                                                                              |
-| `listComments`           |   yes    | `() => Promise<Comment[]>`                       | Fetches all comments from PR                                                                                             |
-| `maxCommentChars`        |   yes    | `number`                                         | Character limit for comment body                                                                                         |
-| `downloadReportArtifact` |    no    | `() => Promise<string \| null>`                  | Fetches previous report for base branch (returns path to downloaded `report.json`), used as cache to speed up comparison |
+| Property                 | Required | Type                                             | Description                                                                                                          |
+| :----------------------- | :------: | :----------------------------------------------- | :------------------------------------------------------------------------------------------------------------------- |
+| `createComment`          |   yes    | `(body: string) => Promise<Comment>`             | Posts a new comment to PR                                                                                            |
+| `updateComment`          |   yes    | `(id: number, body: string) => Promise<Comment>` | Updates existing PR comment                                                                                          |
+| `listComments`           |   yes    | `() => Promise<Comment[]>`                       | Fetches all comments from PR                                                                                         |
+| `maxCommentChars`        |   yes    | `number`                                         | Character limit for comment body                                                                                     |
+| `downloadReportArtifact` |    no    | `(project?: string) => Promise<string \| null>`  | Fetches previous (root/project) `report.json` for base branch and returns path, used as cache to speed up comparison |
 
 A `Comment` object has the following required properties:
 

package/index.js

@@ -19,7 +19,7 @@ var MAX_ISSUE_MESSAGE_LENGTH = 1024;
 var slugRegex = /^[a-z\d]+(?:-[a-z\d]+)*$/;
 var filenameRegex = /^(?!.*[ \\/:*?"<>|]).+$/;
 function hasDuplicateStrings(strings) {
-  const sortedStrings = [...strings].sort();
+  const sortedStrings = strings.toSorted();
   const duplStrings = sortedStrings.filter(
     (item, index) => index !== 0 && item === sortedStrings[index - 1]
   );
@@ -113,7 +113,6 @@ var fileNameSchema = z.string().trim().regex(filenameRegex, {
   message: `The filename has to be valid`
 }).min(1, { message: "file name is invalid" });
 var positiveIntSchema = z.number().int().positive();
-var nonnegativeIntSchema = z.number().int().nonnegative();
 var nonnegativeNumberSchema = z.number().nonnegative();
 function packageVersionSchema(options) {
   const { versionDescription = "NPM version of the package", required } = options ?? {};
@@ -662,7 +661,7 @@ var auditDiffSchema = scorableWithPluginDiffSchema.merge(
   z16.object({
     values: makeComparisonSchema(auditValueSchema).merge(
       z16.object({
-        diff: z16.number().int().describe("Value change (`values.after - values.before`)")
+        diff: z16.number().describe("Value change (`values.after - values.before`)")
       })
     ).describe("Audit `value` comparison"),
     displayValues: makeComparisonSchema(auditDisplayValueSchema).describe(
@@ -756,6 +755,7 @@ function executeProcess(cfg) {
   return new Promise((resolve, reject) => {
     const spawnedProcess = spawn(command, args ?? [], {
       shell: true,
+      windowsHide: true,
       ...options
     });
     let stdout = "";
@@ -1562,6 +1562,7 @@ async function runInCI(refs, api, options, git = simpleGit4()) {
         diffArtifact
       };
     }
+    return { mode: "monorepo", projects: projectResults };
   }
   logger.info("Running Code PushUp in standalone project mode");
   const { artifacts, newIssues } = await runOnProject({
@@ -1610,7 +1611,7 @@ async function runOnProject(args) {
     return noDiffOutput;
   }
   logger.info(
-    `PR detected, preparing to compare base branch ${base.ref} to head ${head.ref}`
+    `PR/MR detected, preparing to compare base branch ${base.ref} to head ${head.ref}`
   );
   const prevReport = await collectPreviousReport({ ...args, base, ctx });
   if (!prevReport) {
@@ -1651,9 +1652,13 @@ async function runOnProject(args) {
   return { ...diffOutput, newIssues };
 }
 async function collectPreviousReport(args) {
-  const { base, api, settings, ctx, git } = args;
+  const { project, base, api, settings, ctx, git } = args;
   const logger = settings.logger;
-  const cachedBaseReport = await api.downloadReportArtifact?.();
+  const cachedBaseReport = await api.downloadReportArtifact?.(project?.name).catch((error) => {
+    logger.warn(
+      `Error when downloading previous report artifact, skipping - ${stringifyError(error)}`
+    );
+  });
   if (api.downloadReportArtifact != null) {
     logger.info(
       `Previous report artifact ${cachedBaseReport ? "found" : "not found"}`
@@ -1686,7 +1691,7 @@ async function collectPreviousReport(args) {
     const prevReport = await fs.readFile(prevReportPath, "utf8");
     logger.debug(`Collected previous report at ${prevReportPath}`);
     await git.checkout(["-f", "-"]);
-    logger.info("Switched back to PR branch");
+    logger.info("Switched back to PR/MR branch");
     return prevReport;
   }
 }
@@ -1705,7 +1710,7 @@ async function findNewIssues(args) {
     changedFiles
   });
   logger.debug(
-    `Found ${issues.length} relevant issues for ${Object.keys(changedFiles).length} changed files and created GitHub annotations`
+    `Found ${issues.length} relevant issues for ${Object.keys(changedFiles).length} changed files`
   );
   return issues;
 }

package/package.json

@@ -1,28 +1,37 @@
 {
   "name": "@code-pushup/ci",
-  "version": "0.53.0",
+  "version": "0.54.0",
   "description": "CI automation logic for Code PushUp (provider-agnostic)",
-  "dependencies": {
-    "@code-pushup/models": "0.53.0",
-    "@code-pushup/utils": "0.53.0",
-    "glob": "^10.4.5",
-    "simple-git": "^3.20.0",
-    "yaml": "^2.5.1"
-  },
   "license": "MIT",
   "homepage": "https://github.com/code-pushup/cli/tree/main/packages/ci#readme",
   "bugs": {
-    "url": "https://github.com/code-pushup/cli/issues"
+    "url": "https://github.com/code-pushup/cli/issues?q=is%3Aissue%20state%3Aopen%20type%3ABug%20label%3A\"🧩%20ci\""
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/code-pushup/cli.git",
     "directory": "packages/ci"
   },
+  "keywords": [
+    "Code PushUp",
+    "CI integration",
+    "automation",
+    "KPI tracking",
+    "tech debt",
+    "automated feedback",
+    "regression guard"
+  ],
   "publishConfig": {
     "access": "public"
   },
   "type": "module",
   "main": "./index.js",
-  "types": "./src/index.d.ts"
-}
+  "types": "./src/index.d.ts",
+  "dependencies": {
+    "@code-pushup/models": "0.54.0",
+    "@code-pushup/utils": "0.54.0",
+    "glob": "^10.4.5",
+    "simple-git": "^3.20.0",
+    "yaml": "^2.5.1"
+  }
+}

package/src/lib/models.d.ts

@@ -33,13 +33,13 @@ export type GitRefs = {
  */
 export type ProviderAPIClient = {
     maxCommentChars: number;
-    downloadReportArtifact?: () => Promise<string | null>;
+    downloadReportArtifact?: (project?: string) => Promise<string | null>;
     listComments: () => Promise<Comment[]>;
     updateComment: (id: number, body: string) => Promise<Comment>;
     createComment: (body: string) => Promise<Comment>;
 };
 /**
- * PR comment from {@link ProviderAPIClient}
+ * PR/MR comment from {@link ProviderAPIClient}
  */
 export type Comment = {
     id: number;