Add configurable lint/test commands and path rewrite action

Copilot · neilime · neilime · commit 5aeae9971132 · 2025-11-20T17:53:53.000+01:00
Co-authored-by: neilime &lt;314088+neilime@users.noreply.github.com&gt;
diff --git a/.github/workflows/continuous-integration.md b/.github/workflows/continuous-integration.md
@@ -104,6 +104,17 @@ jobs:
       # Set to `null` or empty to disable.
       # Accepts a JSON object for lint options. See [lint action](../actions/lint/README.md).
       #
+      # Supported options:
+      # - command: NPM script to run (default: "lint:ci"). The command should generate lint report files.
+      # - report-file: Path to lint report file for annotations.
+      #
+      # Example:
+      # lint: |
+      #   {
+      #     "command": "lint:ci",
+      #     "report-file": "reports/eslint.json"
+      #   }
+      #
       # Default: `true`
       lint: "true"
 
@@ -119,6 +130,19 @@ jobs:
       # Set to `null` or empty to disable.
       # Accepts a JSON object for test options. See [test action](../actions/test/README.md).
       #
+      # Supported options:
+      # - command: NPM script to run (default: "test:ci"). The command should generate coverage report files.
+      # - coverage: Coverage reporter ("github", "codecov", or "" for none).
+      # - coverage-files: Path to coverage files for reporting.
+      #
+      # Example:
+      # test: |
+      #   {
+      #     "command": "test:ci",
+      #     "coverage": "github",
+      #     "coverage-files": "coverage/cobertura-coverage.xml"
+      #   }
+      #
       # Default: `true`
       test: "true"
 
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -56,6 +56,18 @@ on:
           Whether to enable linting.
           Set to `null` or empty to disable.
           Accepts a JSON object for lint options. See [lint action](../actions/lint/README.md).
+          
+          Supported options:
+          - `command`: NPM script to run (default: "lint:ci"). The command should generate lint report files.
+          - `report-file`: Path to lint report file for annotations.
+          
+          Example:
+          ```json
+          {
+            "command": "lint:ci",
+            "report-file": "reports/eslint.json"
+          }
+          ```
         type: string
         required: false
         default: "true"
@@ -74,6 +86,20 @@ on:
           Whether to enable testing.
           Set to `null` or empty to disable.
           Accepts a JSON object for test options. See [test action](../actions/test/README.md).
+          
+          Supported options:
+          - `command`: NPM script to run (default: "test:ci"). The command should generate coverage report files.
+          - `coverage`: Coverage reporter ("github", "codecov", or "" for none).
+          - `coverage-files`: Path to coverage files for reporting.
+          
+          Example:
+          ```json
+          {
+            "command": "test:ci",
+            "coverage": "github",
+            "coverage-files": "coverage/cobertura-coverage.xml"
+          }
+          ```
         type: string
         required: false
         default: "true"
@@ -417,10 +443,26 @@ jobs:
               }
             }
 
+            core.setOutput('command', lintOptions.command || 'lint:ci');
+            core.setOutput('report-file', lintOptions['report-file'] || '');
+
       - uses: ./self-workflow/actions/lint
         with:
           working-directory: ${{ inputs.working-directory }}
           container: ${{ needs.prepare.outputs.container-image && 'true' || 'false' }}
+          command: ${{ steps.preparel-lint-options.outputs.command }}
+          report-file: ${{ steps.preparel-lint-options.outputs.report-file }}
+
+      - name: 🔄 Rewrite lint report paths (container mode)
+        if: always() && needs.prepare.outputs.container-image
+        uses: ./self-workflow/actions/rewrite-report-paths
+        with:
+          working-directory: ${{ inputs.working-directory }}
+          report-files: |
+            **/*eslint*.json
+            **/*checkstyle*.xml
+            reports/**/*.json
+            reports/**/*.xml
 
   build:
     name: 🏗️ Build
@@ -530,13 +572,25 @@ jobs:
               testOptions.coverage = 'github';
             }
             core.setOutput('coverage', testOptions.coverage );
-
             core.setOutput('coverage-files', testOptions['coverage-files'] || '');
+            core.setOutput('command', testOptions.command || 'test:ci');
 
       - uses: ./self-workflow/actions/test
         with:
           working-directory: ${{ inputs.working-directory }}
           container: ${{ needs.prepare.outputs.container-image && 'true' || 'false' }}
+          command: ${{ steps.prepare-test-options.outputs.command }}
           coverage: ${{ steps.prepare-test-options.outputs.coverage }}
           coverage-files: ${{ steps.prepare-test-options.outputs.coverage-files }}
           github-token: ${{ github.token }}
+
+      - name: 🔄 Rewrite coverage report paths (container mode)
+        if: always() && needs.prepare.outputs.container-image
+        uses: ./self-workflow/actions/rewrite-report-paths
+        with:
+          working-directory: ${{ inputs.working-directory }}
+          report-files: |
+            coverage/**/*.xml
+            coverage/**/*.info
+            coverage/**/*.json
+            test-results/**/*.xml
diff --git a/README.md b/README.md
@@ -28,6 +28,8 @@ _Actions for continuous integration steps: build, lint, and test._
 
 #### - [Test](actions/test/README.md)
 
+#### - [Rewrite Report Paths](actions/rewrite-report-paths/README.md)
+
 ### Dependencies
 
 _Actions dedicated to caching and validating Node.js dependencies._
diff --git a/actions/lint/README.md b/actions/lint/README.md
@@ -42,6 +42,13 @@ Action to lint Node.js projects with support for pull request reporting and anno
     # Default: `false`
     container: "false"
 
+    # NPM/package manager script command to run for linting.
+    # This should be a script defined in your package.json.
+    # The command should generate lint report files in a standard format (ESLint JSON or Checkstyle XML).
+    #
+    # Default: `lint:ci`
+    command: "lint:ci"
+
     # Path to lint report file to process as GitHub annotations.
     # Supports ESLint JSON and Checkstyle XML formats.
     # If not specified, auto-detection will be attempted for common paths:
@@ -55,16 +62,19 @@ Action to lint Node.js projects with support for pull request reporting and anno
 
 ## Inputs
 
-| **Input**               | **Description**                                                      | **Required** | **Default** |
-| ----------------------- | -------------------------------------------------------------------- | ------------ | ----------- |
-| **`working-directory`** | Working directory where lint commands are executed.                  | **false**    | `.`         |
-|                         | Can be absolute or relative to the repository root.                  |              |             |
-| **`container`**         | Whether running in container mode (skips checkout and node setup)    | **false**    | `false`     |
-| **`report-file`**       | Path to lint report file to process as GitHub annotations.           | **false**    | -           |
-|                         | Supports ESLint JSON and Checkstyle XML formats.                     |              |             |
-|                         | If not specified, auto-detection will be attempted for common paths: |              |             |
-|                         | - eslint-report.json, eslint.json                                    |              |             |
-|                         | - checkstyle-result.xml, checkstyle.xml                              |              |             |
+| **Input**               | **Description**                                                  | **Required** | **Default** |
+| ----------------------- | ---------------------------------------------------------------- | ------------ | ----------- |
+| **`working-directory`** | Working directory where lint commands are executed.              | **false**    | `.`         |
+|                         | Can be absolute or relative to the repository root.              |              |             |
+| **`container`**         | Whether running in container mode (skips checkout and node setup)| **false**    | `false`     |
+| **`command`**           | NPM/package manager script command to run for linting.           | **false**    | `lint:ci`   |
+|                         | This should be a script defined in your package.json.            |              |             |
+|                         | The command should generate lint report files in a standard format.|            |             |
+| **`report-file`**       | Path to lint report file to process as GitHub annotations.       | **false**    | -           |
+|                         | Supports ESLint JSON and Checkstyle XML formats.                 |              |             |
+|                         | If not specified, auto-detection will be attempted for common paths:|          |             |
+|                         | - eslint-report.json, eslint.json                                |              |             |
+|                         | - checkstyle-result.xml, checkstyle.xml                          |              |             |
 
 <!-- inputs:end -->
 <!-- secrets:start -->
diff --git a/actions/lint/action.yml b/actions/lint/action.yml
@@ -16,6 +16,13 @@ inputs:
     description: "Whether running in container mode (skips checkout and node setup)"
     required: false
     default: "false"
+  command:
+    description: |
+      NPM/package manager script command to run for linting.
+      This should be a script defined in your package.json.
+      The command should generate lint report files in a standard format (ESLint JSON or Checkstyle XML).
+    required: false
+    default: "lint:ci"
   report-file:
     description: |
       Path to lint report file to process as GitHub annotations.
@@ -53,15 +60,17 @@ runs:
       env:
         RUN_LINT_COMMAND: ${{ inputs.container == 'true' && steps.get-package-manager.outputs.run-script-command || steps.setup-node.outputs.run-script-command }}
         WORKING_DIRECTORY: ${{ inputs.working-directory }}
+        LINT_COMMAND: ${{ inputs.command }}
       with:
         script: |
           const workingDirectory = process.env.WORKING_DIRECTORY || '.';
           const runScriptCommand = process.env.RUN_LINT_COMMAND;
+          const lintCommand = process.env.LINT_COMMAND || 'lint:ci';
 
-          core.info('👕 Running lint...');
+          core.info(`👕 Running lint command: ${lintCommand}...`);
 
           try {
-            const result = await exec.getExecOutput(runScriptCommand, ['lint'], {
+            const result = await exec.getExecOutput(runScriptCommand, [lintCommand], {
               cwd: require('path').resolve(process.env.GITHUB_WORKSPACE, workingDirectory),
               ignoreReturnCode: true
             });
diff --git a/actions/rewrite-report-paths/README.md b/actions/rewrite-report-paths/README.md
@@ -0,0 +1,175 @@
+<!-- header:start -->
+
+# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItZWRpdCIgY29sb3I9ImJsdWUiPjxwYXRoIGQ9Ik0xMSA0SDRhMiAyIDAgMCAwLTIgMnYxNGEyIDIgMCAwIDAgMiAyaDE0YTIgMiAwIDAgMCAyLTJ2LTciPjwvcGF0aD48cGF0aCBkPSJNMTguNSAyLjVhMi4xMjEgMi4xMjEgMCAwIDEgMyAzbC0xMiAxMi0zIDEgMS0zIDEyLTEyeiI+PC9wYXRoPjwvc3ZnPg==) GitHub Action: Rewrite Report Paths
+
+<div align="center">
+  <img src="https://opengraph.githubassets.com/50237226ce5d3230f19bbf31d04efd98f21cb2150e9ae4acd09a498440ecde82/hoverkraft-tech/ci-github-nodejs" width="60px" align="center" alt="Rewrite Report Paths" />
+</div>
+
+---
+
+<!-- header:end -->
+<!-- badges:start -->
+
+[![Marketplace](https://img.shields.io/badge/Marketplace-rewrite--report--paths-blue?logo=github-actions)](https://github.com/marketplace/actions/rewrite-report-paths)
+[![Release](https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-nodejs)](https://github.com/hoverkraft-tech/ci-github-nodejs/releases)
+[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-nodejs)](http://choosealicense.com/licenses/mit/)
+[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-nodejs?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-nodejs?style=social)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-nodejs/blob/main/CONTRIBUTING.md)
+
+<!-- badges:end -->
+<!-- overview:start -->
+
+## Overview
+
+Rewrites file paths in report files to match repository paths when running in containers.
+
+When running tests or linting in Docker containers, the file paths in generated reports (coverage, lint results, etc.) often reference the container's internal paths (e.g., `/app/src/file.js`). This action rewrites those paths to match the actual repository structure, ensuring that GitHub annotations and coverage reports correctly reference the source files.
+
+<!-- overview:end -->
+<!-- usage:start -->
+
+## Usage
+
+```yaml
+- uses: hoverkraft-tech/ci-github-nodejs/actions/rewrite-report-paths@main
+  with:
+    # Path or glob pattern for report files to process.
+    # Supports multiple files separated by newlines.
+    # Common patterns: coverage/**, reports/**, **/*.xml, **/*.json
+    #
+    # Required: true
+    report-files: |
+      coverage/cobertura-coverage.xml
+      reports/eslint.json
+
+    # Source root path in the container that should be replaced.
+    # If not specified, will attempt to auto-detect from file paths.
+    # Common values: /app, /workspace, /usr/src/app
+    #
+    # Default: "" (auto-detect)
+    source-root: "/app"
+
+    # Target root path in the repository.
+    # Typically this is the GITHUB_WORKSPACE or a subdirectory.
+    #
+    # Default: GITHUB_WORKSPACE
+    target-root: ""
+
+    # Working directory where report files are located.
+    # Can be absolute or relative to the repository root.
+    #
+    # Default: `.`
+    working-directory: .
+```
+
+<!-- usage:end -->
+<!-- inputs:start -->
+
+## Inputs
+
+| **Input**               | **Description**                                                  | **Required** | **Default** |
+| ----------------------- | ---------------------------------------------------------------- | ------------ | ----------- |
+| **`report-files`**      | Path or glob pattern for report files to process.                | **true**     | -           |
+|                         | Supports multiple files separated by newlines.                   |              |             |
+|                         | Common patterns: coverage/\*\*, reports/\*\*, \*\*/\*.xml, \*\*/\*.json |              |             |
+| **`source-root`**       | Source root path in the container that should be replaced.       | **false**    | -           |
+|                         | If not specified, will attempt to auto-detect from file paths.   |              |             |
+| **`target-root`**       | Target root path in the repository.                              | **false**    | -           |
+|                         | Typically this is the GITHUB_WORKSPACE or a subdirectory.        |              |             |
+| **`working-directory`** | Working directory where report files are located.                | **false**    | `.`         |
+|                         | Can be absolute or relative to the repository root.              |              |             |
+
+<!-- inputs:end -->
+<!-- secrets:start -->
+<!-- secrets:end -->
+<!-- outputs:start -->
+
+## Outputs
+
+| **Output**            | **Description**                                   |
+| --------------------- | ------------------------------------------------- |
+| **`files-processed`** | Number of report files that were processed        |
+| **`paths-replaced`**  | Total number of paths that were rewritten         |
+
+<!-- outputs:end -->
+<!-- examples:start -->
+
+## Examples
+
+### Basic Usage with Auto-Detection
+
+```yaml
+- name: Rewrite coverage paths
+  uses: hoverkraft-tech/ci-github-nodejs/actions/rewrite-report-paths@main
+  with:
+    report-files: |
+      coverage/cobertura-coverage.xml
+      coverage/lcov.info
+```
+
+### Explicit Source Root
+
+```yaml
+- name: Rewrite report paths
+  uses: hoverkraft-tech/ci-github-nodejs/actions/rewrite-report-paths@main
+  with:
+    report-files: |
+      coverage/**/*.xml
+      reports/**/*.json
+    source-root: "/app"
+    target-root: ${{ github.workspace }}
+```
+
+### Multiple Report Types
+
+```yaml
+- name: Rewrite all report paths
+  uses: hoverkraft-tech/ci-github-nodejs/actions/rewrite-report-paths@main
+  with:
+    report-files: |
+      coverage/cobertura-coverage.xml
+      reports/eslint.json
+      test-results/junit.xml
+    source-root: "/workspace"
+```
+
+<!-- examples:end -->
+
+<!--
+// jscpd:ignore-start
+-->
+
+<!-- contributing:start -->
+
+## Contributing
+
+Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-nodejs/blob/main/CONTRIBUTING.md) for more details.
+
+<!-- contributing:end -->
+<!-- security:start -->
+<!-- security:end -->
+<!-- license:start -->
+
+## License
+
+This project is licensed under the MIT License.
+
+SPDX-License-Identifier: MIT
+
+Copyright © 2025 hoverkraft
+
+For more details, see the [license](http://choosealicense.com/licenses/mit/).
+
+<!-- license:end -->
+<!-- generated:start -->
+
+---
+
+This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
+
+<!-- generated:end -->
+
+<!--
+// jscpd:ignore-end
+-->
diff --git a/actions/rewrite-report-paths/action.yml b/actions/rewrite-report-paths/action.yml
diff --git a/actions/test/README.md b/actions/test/README.md
diff --git a/actions/test/action.yml b/actions/test/action.yml
