Improve logs

Author: matejchalk

__tests__/monorepo.test.ts

@@ -4,6 +4,8 @@ import type { PackageJson } from 'type-fest'
 import type { ActionInputs } from '../src/inputs'
 import { listMonorepoProjects, type ProjectConfig } from '../src/monorepo'
 
+jest.mock('@actions/core')
+
 jest.mock('fs', () => {
   const memfs: typeof import('memfs') = jest.requireActual('memfs')
   return memfs.fs

dist/index.js

@@ -2,6 +2,10 @@ import * as core from '@actions/core'
 import type { SourceFileIssue } from './issues'
 
 export function createAnnotationsFromIssues(issues: SourceFileIssue[]): void {
+  if (issues.length > 0) {
+    core.info(`Creating annotations for ${issues.length} issues:`)
+  }
+
   for (const issue of issues) {
     const message = issue.message
     const properties: core.AnnotationProperties = {

dist/index.js.map

@@ -34,11 +34,11 @@ export async function run(
     let commentMdPath: string | undefined
 
     if (inputs.monorepo) {
-      core.debug('Running Code PushUp in monorepo mode')
+      core.info('Running Code PushUp in monorepo mode')
       const projects = await listMonorepoProjects(inputs)
       const diffJsonPaths: string[] = []
       for (const project of projects) {
-        core.debug(`Running Code PushUp on monorepo project ${project.name}`)
+        core.info(`Running Code PushUp on monorepo project ${project.name}`)
         const comparisonFiles = await runOnProject(
           project,
           inputs,
@@ -67,7 +67,7 @@ export async function run(
         core.debug(`Uploaded report diff artifact (${size} bytes)`)
       }
     } else {
-      core.debug('Running Code PushUp in standalone project mode')
+      core.info('Running Code PushUp in standalone project mode')
       const comparisonFiles = await runOnProject(null, inputs, artifact, git)
       if (comparisonFiles) {
         commentMdPath = comparisonFiles.mdFilePath
@@ -77,7 +77,7 @@ export async function run(
     if (commentMdPath) {
       const commentId = await commentOnPR(commentMdPath, inputs)
       core.setOutput('comment-id', commentId)
-      core.debug(`Commented on PR #${github.context.issue.number}`)
+      core.info(`Commented on PR #${github.context.issue.number}`)
     }
   } catch (error) {
     core.setFailed(error instanceof Error ? error.message : `${error}`)
@@ -115,33 +115,39 @@ async function runOnProject(
   }
 
   const { base } = github.context.payload.pull_request
-  core.debug(`PR detected, preparing to compare base branch ${base.ref}`)
+  core.info(`PR detected, preparing to compare base branch ${base.ref}`)
 
   let prevReport: string
 
   let cachedBaseReport: PersistedCliFiles | null = null
   if (inputs.artifacts) {
     cachedBaseReport = await downloadReportArtifact(artifact, base, inputs)
-    core.debug(
-      `Previous report artifact ${cachedBaseReport ? `found and downloaded to ${cachedBaseReport.jsonFilePath}` : `not found`}`
+    core.info(
+      `Previous report artifact ${cachedBaseReport ? 'found' : 'not found'}`
     )
+    if (cachedBaseReport) {
+      core.debug(
+        `Previous report artifact downloaded to ${cachedBaseReport.jsonFilePath}`
+      )
+    }
   }
 
   if (cachedBaseReport) {
     prevReport = await fs.readFile(cachedBaseReport.jsonFilePath, 'utf8')
   } else {
     await git.fetch('origin', base.ref, ['--depth=1'])
     await git.checkout(['-f', base.ref])
-    core.debug(`Switched to base branch ${base.ref}`)
+    core.info(`Switched to base branch ${base.ref}`)
 
     try {
-      await printConfig(ctx)
+      await printConfig({ ...ctx, silent: !core.isDebug() })
       core.debug(
         `Executing print-config verified code-pushup installed in base branch ${base.ref}`
       )
     } catch (err) {
-      core.debug(
-        `Executing print-config failed, assuming code-pushup not installed in base branch ${base.ref} and skipping comparison - ${err}`
+      core.debug(`Error from print-config - ${err}`)
+      core.info(
+        `Executing print-config failed, assuming code-pushup not installed in base branch ${base.ref} and skipping comparison`
       )
       return null
     }
@@ -151,7 +157,7 @@ async function runOnProject(
     core.debug(`Collected previous report at ${prevReportPath}`)
 
     await git.checkout(['-f', '-'])
-    core.debug('Switched back to current branch')
+    core.info('Switched back to PR branch')
   }
 
   const reportsDir = path.join(inputs.directory, '.code-pushup')
@@ -165,8 +171,9 @@ async function runOnProject(
     { before: prevPath, after: currPath, label: project?.name },
     ctx
   )
+  core.info('Compared reports and generated diff files')
   core.debug(
-    `Compared reports and generated diff at ${comparisonFiles.jsonFilePath} and ${comparisonFiles.mdFilePath}`
+    `Generated diff files at ${comparisonFiles.jsonFilePath} and ${comparisonFiles.mdFilePath}`
   )
 
   if (inputs.annotations) {

src/annotations.ts

@@ -1,3 +1,4 @@
+import * as core from '@actions/core'
 import { glob } from 'fast-glob'
 import { join } from 'node:path'
 import type { ActionInputs } from '../inputs'
@@ -26,17 +27,33 @@ export async function listMonorepoProjects(
     inputs.monorepo === true
       ? await detectMonorepoTool(options)
       : inputs.monorepo
+  if (inputs.monorepo === true) {
+    if (tool) {
+      core.info(`Auto-detected monorepo tool ${tool}`)
+    } else {
+      core.info("Couldn't auto-detect any supported monorepo tool")
+    }
+  } else {
+    core.info(`Using monorepo tool "${tool}" from inputs`)
+  }
 
   if (tool) {
     const handler = getToolHandler(tool)
-    return handler.listProjects(options)
+    const projects = await handler.listProjects(options)
+    core.info(`Found ${projects.length} projects in ${tool} monorepo`)
+    core.debug(`Projects: ${projects.map(({ name }) => name).join(', ')}`)
+    return projects
   }
 
   if (inputs.projects) {
     const directories = await glob(inputs.projects, {
       cwd: options.cwd,
       onlyDirectories: true
     })
+    core.info(
+      `Found ${directories.length} project folders matching "${inputs.projects}" from inputs`
+    )
+    core.debug(`Projects: ${directories.join(', ')}`)
     return directories.map(directory => ({
       name: directory,
       bin: inputs.bin,
@@ -45,6 +62,8 @@ export async function listMonorepoProjects(
   }
 
   const packages = await listPackages(options.cwd)
+  core.info(`Found ${packages.length} NPM packages in repository`)
+  core.debug(`Projects: ${packages.map(({ name }) => name).join(', ')}`)
   return packages.map(({ name, directory }) => ({
     name,
     bin: inputs.bin,