Add auto-detection, GitHub annotations, and use hoverkraft setup-node

Copilot · neilime · Copilot · commit dc5b77b09bc7 · 2025-11-19T16:06:55.000Z
Co-authored-by: neilime &lt;314088+neilime@users.noreply.github.com&gt;
diff --git a/actions/parse-ci-reports/README.md b/actions/parse-ci-reports/README.md
@@ -43,6 +43,35 @@ It supports multiple common report standards out of the box.
     report-name: "CI Results"
 ```
 
+### Auto-Detection Mode
+
+Let the action automatically find common report files:
+
+```yaml
+- name: Parse all CI reports
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@v1
+  with:
+    report-paths: "auto:all"
+    report-name: "CI Results"
+```
+
+Or target specific report types:
+
+```yaml
+- name: Parse test reports only
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@v1
+  with:
+    report-paths: "auto:test"
+    report-name: "Test Results"
+```
+
+Auto-detection modes:
+
+- `auto:test` - Finds JUnit XML and TAP files
+- `auto:coverage` - Finds LCOV and Cobertura coverage files
+- `auto:lint` - Finds ESLint JSON and CheckStyle XML files
+- `auto:all` - Finds all supported report types
+
 ### Generate PR Comment
 
 ```yaml
@@ -83,15 +112,28 @@ It supports multiple common report standards out of the box.
     fail-on-error: "true"
 ```
 
+### GitHub Annotations
+
+Generate GitHub annotations for failed tests and linting issues:
+
+```yaml
+- name: Parse reports with annotations
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@v1
+  with:
+    report-paths: "auto:all"
+    report-name: "CI Results"
+    output-format: "annotations"
+```
+
 ## Inputs
 
-| Input            | Description                                                                      | Required | Default            |
-| ---------------- | -------------------------------------------------------------------------------- | -------- | ------------------ |
-| `report-paths`   | Paths to report files (glob patterns supported, one per line or comma-separated) | Yes      | -                  |
-| `report-name`    | Name to display in the summary                                                   | No       | `"Report Summary"` |
-| `include-passed` | Whether to include passed tests in the summary                                   | No       | `false`            |
-| `output-format`  | Output format: 'summary', 'Markdown', or 'both'                                  | No       | `"both"`           |
-| `fail-on-error`  | Whether to fail the action if any test failures are detected                     | No       | `false`            |
+| Input            | Description                                                                                                                    | Required | Default            |
+| ---------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------- | ------------------ |
+| `report-paths`   | Paths to report files (glob patterns supported) or auto-detection mode ('auto:test', 'auto:coverage', 'auto:lint', 'auto:all') | Yes      | -                  |
+| `report-name`    | Name to display in the summary                                                                                                 | No       | `"Report Summary"` |
+| `include-passed` | Whether to include passed tests in the summary                                                                                 | No       | `false`            |
+| `output-format`  | Output format: 'summary', 'Markdown', 'annotations', or 'both'                                                                 | No       | `"both"`           |
+| `fail-on-error`  | Whether to fail the action if any test failures are detected                                                                   | No       | `false`            |
 
 ## Outputs
 
diff --git a/actions/parse-ci-reports/action.yml b/actions/parse-ci-reports/action.yml
@@ -9,7 +9,8 @@ inputs:
   report-paths:
     description: |
       Paths to report files (glob patterns supported, one per line or comma-separated).
-      Examples: '**/junit.xml', 'coverage/lcov.info', 'eslint-report.json'
+      Set to 'auto:test', 'auto:coverage', 'auto:lint', or 'auto:all' for automatic detection.
+      Examples: '**/junit.xml', 'coverage/lcov.info', 'eslint-report.json', 'auto:all'
     required: true
   report-name:
     description: |
@@ -21,7 +22,7 @@ inputs:
     default: "false"
   output-format:
     description: |
-      Output format: 'summary' (GitHub Step Summary), 'markdown' (for PR comments), or 'both'.
+      Output format: 'summary' (GitHub Step Summary), 'markdown' (for PR comments), 'annotations' (GitHub annotations), or 'both'.
     default: "both"
   fail-on-error:
     description: |
@@ -58,20 +59,15 @@ runs:
   using: "composite"
   steps:
     - name: Setup Node.js
-      uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
+      uses: hoverkraft-tech/ci-github-nodejs/actions/setup-node@32a69b7b8fd5f7ab7bf656e7e88aa90ad235cf8d # 0.18.0
       with:
-        node-version: "18"
-
-    - name: Install dependencies
-      shell: bash
-      run: |
-        cd ${{ github.action_path }}
-        npm ci --omit=dev
+        working-directory: ${{ github.action_path }}
 
     - name: Parse reports
       id: parse-reports
       uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
       env:
+        NODE_PATH: ${{ github.action_path }}/node_modules
         REPORT_PATHS: ${{ inputs.report-paths }}
         REPORT_NAME: ${{ inputs.report-name }}
         INCLUDE_PASSED: ${{ inputs.include-passed }}
diff --git a/actions/parse-ci-reports/src/index-action.js b/actions/parse-ci-reports/src/index-action.js
@@ -1,3 +1,27 @@
+// Auto-detection patterns for common report files
+const AUTO_PATTERNS = {
+  test: [
+    "**/junit*.xml",
+    "**/test-results/**/*.xml",
+    "**/test-reports/**/*.xml",
+    "**/*test*.xml",
+    "**/*.tap",
+  ],
+  coverage: [
+    "**/coverage/lcov.info",
+    "**/coverage/cobertura-coverage.xml",
+    "**/coverage.xml",
+    "**/lcov.info",
+    "**/cobertura.xml",
+  ],
+  lint: [
+    "**/eslint-report.json",
+    "**/eslint.json",
+    "**/checkstyle-result.xml",
+    "**/checkstyle.xml",
+  ],
+};
+
 // Dynamically import ES modules
 async function runAction({ core, glob: globModule, inputs }) {
   try {
@@ -9,12 +33,33 @@ async function runAction({ core, glob: globModule, inputs }) {
     core.info(`Report Name: ${inputs.reportName}`);
     core.info(`Output Format: ${inputs.outputFormat}`);
 
-    // Find report files using glob
-    const patternList = inputs.reportPaths
+    // Handle auto-detection
+    let patternList = inputs.reportPaths
       .split(/[,\n]/)
       .map((p) => p.trim())
       .filter((p) => p.length > 0);
 
+    // Check for auto mode
+    const autoMode = patternList.find((p) => p.startsWith("auto:"));
+    if (autoMode) {
+      const mode = autoMode.split(":")[1];
+      core.info(`Auto-detection mode: ${mode}`);
+
+      patternList = [];
+      if (mode === "all" || mode === "test") {
+        patternList.push(...AUTO_PATTERNS.test);
+      }
+      if (mode === "all" || mode === "coverage") {
+        patternList.push(...AUTO_PATTERNS.coverage);
+      }
+      if (mode === "all" || mode === "lint") {
+        patternList.push(...AUTO_PATTERNS.lint);
+      }
+
+      core.info(`Using patterns: ${patternList.join(", ")}`);
+    }
+
+    // Find report files using glob
     const files = [];
     for (const pattern of patternList) {
       const globber = await globModule.create(pattern, {
@@ -40,6 +85,14 @@ async function runAction({ core, glob: globModule, inputs }) {
       (msg) => core.error(msg),
     );
 
+    // Generate GitHub annotations if requested
+    if (
+      inputs.outputFormat === "annotations" ||
+      inputs.outputFormat === "both"
+    ) {
+      generateAnnotations(core, aggregatedData);
+    }
+
     // Generate outputs using core
     const { markdown, summary } = parserCore.generateOutput(
       aggregatedData,
@@ -86,4 +139,44 @@ async function runAction({ core, glob: globModule, inputs }) {
   }
 }
 
+/**
+ * Generate GitHub annotations for failed tests and lint issues
+ */
+function generateAnnotations(core, reportData) {
+  // Annotate failed tests
+  const failedTests = reportData.getFailedTests();
+  for (const test of failedTests.slice(0, 10)) {
+    // Limit to 10 annotations
+    const properties = {
+      title: `Test Failed: ${test.name}`,
+    };
+
+    if (test.file) {
+      properties.file = test.file;
+    }
+
+    core.error(test.message || "Test failed", properties);
+  }
+
+  // Annotate lint errors and warnings
+  annotateLintIssues(core, reportData.getErrors(), core.error, 10);
+  annotateLintIssues(core, reportData.getWarnings(), core.warning, 10);
+}
+
+/**
+ * Helper to annotate lint issues
+ */
+function annotateLintIssues(core, issues, annotationFn, limit) {
+  for (const issue of issues.slice(0, limit)) {
+    const properties = {
+      title: `${issue.rule}: ${issue.message}`,
+      file: issue.file,
+      startLine: issue.line,
+      startColumn: issue.column,
+    };
+
+    annotationFn.call(core, issue.message, properties);
+  }
+}
+
 module.exports = { runAction };
