Add lint:ci script to test package.json

Co-authored-by: neilime <314088+neilime@users.noreply.github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>

Author: Copilot

.github/linters/actionlint.yml

@@ -8,3 +8,10 @@ paths:
       - '"env" section must be mapping node but got scalar node'
       - '"ports" section must be sequence node but got scalar node'
       - '"volumes" section must be sequence node but got scalar node'
+      - '"steps" section must be sequence node but got alias node with "" tag'
+      - '"runs-on" section is alias node but mapping node is expected'
+      - "is not defined in object type {}"
+      - 'expected scalar node for string value but found alias node with "" tag'
+      - '"steps" section is missing in job'
+      - '"outputs" section should not be empty'
+      - '"outputs" section is alias node but mapping node is expected'

.github/workflows/continuous-integration.yml

@@ -56,18 +56,6 @@ 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"
@@ -86,20 +74,6 @@ 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"
@@ -162,14 +136,14 @@ on:
     outputs:
       build-artifact-id:
         description: "ID of the build artifact) uploaded during the build step."
-        value: ${{ jobs.build.outputs.artifact-id }}
+        value: ${{ jobs.build-host.outputs.artifact-id || jobs.build-container.outputs.artifact-id }}
 
 permissions: {}
 
 jobs:
   prepare:
     name: 📦 Prepare configuration
-    runs-on: ${{ inputs.runs-on && fromJson(inputs.runs-on) || 'ubuntu-latest' }}
+    runs-on: &ci-runner ${{ inputs.runs-on && fromJson(inputs.runs-on) || 'ubuntu-latest' }}
     permissions: {}
     outputs:
       container-image: ${{ steps.parse.outputs.container-image }}
@@ -254,7 +228,7 @@ jobs:
     if: inputs.checks == true && inputs.code-ql != ''
     permissions:
       security-events: write
-    runs-on: ${{ inputs.runs-on && fromJson(inputs.runs-on) || 'ubuntu-latest' }}
+    runs-on: *ci-runner
     steps:
       - uses: hoverkraft-tech/ci-github-common/actions/checkout@753288393de1f3d92f687a6761d236ca800f5306 # 0.28.1
       - uses: github/codeql-action/init@014f16e7ab1402f30e7c3329d33797e7948572db # v4.31.3
@@ -267,32 +241,28 @@ jobs:
     if: github.event_name == 'pull_request' && inputs.checks == true && inputs.dependency-review
     permissions:
       contents: read
-    runs-on: ${{ inputs.runs-on && fromJson(inputs.runs-on) || 'ubuntu-latest' }}
+    runs-on: *ci-runner
     steps:
       - uses: hoverkraft-tech/ci-github-common/actions/checkout@753288393de1f3d92f687a6761d236ca800f5306 # 0.28.1
       - uses: actions/dependency-review-action@3c4e3dcb1aa7874d2c16be7d79418e9b7efd6261 # v4.8.2
 
-  setup:
-    name: ⚙️ Setup
-    runs-on: ${{ inputs.runs-on && fromJson(inputs.runs-on) || 'ubuntu-latest' }}
-    needs: prepare
-    container: &container-setup
-      image: ${{ needs.prepare.outputs.container-image || '' }}
-      env: ${{ fromJSON(needs.prepare.outputs.container-env || '{}') }}
-      options: ${{ needs.prepare.outputs.container-options || ' ' }}
-      ports: ${{ fromJSON(needs.prepare.outputs.container-ports || '[]') }}
-      volumes: ${{ fromJSON(needs.prepare.outputs.container-volumes || '[]') }}
-      credentials: ${{ fromJSON(needs.prepare.outputs.container-username && format('{{"username":{0},"password":{1}}}',toJSON(needs.prepare.outputs.container-username),toJSON(secrets.container-password)) || '{}') }}
+  setup-host:
+    if: ${{ inputs.container == '' }}
+    name: &setup-name ⚙️ Setup
+    runs-on: *ci-runner
+    needs:
+      - prepare
     permissions:
       contents: read
       # FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
       id-token: write
-    outputs:
+    outputs: &setup-outputs
       build-env: ${{ steps.build-variables.outputs.env }}
       build-commands: ${{ steps.build-variables.outputs.commands }}
       build-artifact: ${{ steps.build-variables.outputs.artifact }}
-    steps:
-      - if: needs.prepare.outputs.container-image == null
+    steps: &setup-steps
+      - name: Checkout repository
+        if: inputs.container == ''
         uses: hoverkraft-tech/ci-github-common/actions/checkout@753288393de1f3d92f687a6761d236ca800f5306 # 0.28.1
 
       - id: build-variables
@@ -394,22 +364,40 @@ jobs:
             core.setOutput('commands', sanitizedCommands.join('\n'));
             core.setOutput('env', JSON.stringify(env));
 
-  lint:
-    name: 👕 Lint
-    if: inputs.checks == true && inputs.lint
+  setup-container:
+    if: ${{ inputs.container != '' }}
+    permissions:
+      contents: read
+      # FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
+      id-token: write
+    needs:
+      - prepare
+    container: &ci-container
+      image: ${{ needs.prepare.outputs.container-image }}
+      env: ${{ fromJSON(needs.prepare.outputs.container-env || '{}') }}
+      options: ${{ needs.prepare.outputs.container-options || ' ' }}
+      ports: ${{ fromJSON(needs.prepare.outputs.container-ports || '[]') }}
+      volumes: ${{ fromJSON(needs.prepare.outputs.container-volumes || '[]') }}
+      credentials: ${{ fromJSON(needs.prepare.outputs.container-username && format('{{"username":{0},"password":{1}}}',toJSON(needs.prepare.outputs.container-username),toJSON(secrets.container-password)) || '{}') }}
+    name: *setup-name
+    runs-on: *ci-runner
+    outputs: *setup-outputs
+    steps: *setup-steps
+
+  lint-host:
+    if: ${{ inputs.checks == true && inputs.lint && inputs.container == '' }}
+    name: &lint-name 👕 Lint
+    runs-on: *ci-runner
     needs:
       - prepare
-      - setup
-    runs-on: ${{ inputs.runs-on && fromJson(inputs.runs-on) || 'ubuntu-latest' }}
-    container: *container-setup
-    # jscpd:ignore-start
+      - setup-host
     permissions:
       contents: read
       # FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
       id-token: write
-    steps:
+    steps: &lint-steps
       - uses: hoverkraft-tech/ci-github-common/actions/checkout@753288393de1f3d92f687a6761d236ca800f5306 # 0.28.1
-        if: needs.prepare.outputs.container-image == null
+        if: inputs.container == ''
 
       - id: oidc
         uses: ChristopherHX/oidc@73eee1ff03fdfce10eda179f617131532209edbd # v3
@@ -423,7 +411,7 @@ jobs:
       - run: |
           if [ -f .gitignore ]; then grep -q "self-workflow" .gitignore || echo "self-workflow" >> .gitignore; else echo "self-workflow" >> .gitignore; fi
           if [ -f .dockerignore ]; then grep -q "self-workflow" .dockerignore || echo "self-workflow" >> .dockerignore; else echo "self-workflow" >> .dockerignore; fi
-      # jscpd:ignore-end
+
       - id: preparel-lint-options
         uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
         env:
@@ -446,93 +434,119 @@ jobs:
             core.setOutput('command', lintOptions.command || 'lint:ci');
             core.setOutput('report-file', lintOptions['report-file'] || '');
 
-      - uses: ./self-workflow/actions/lint
+      - name: Run lint
+        uses: ./self-workflow/actions/lint
         with:
           working-directory: ${{ inputs.working-directory }}
-          container: ${{ needs.prepare.outputs.container-image && 'true' || 'false' }}
+          container: ${{ inputs.container != '' && '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
-    if: inputs.checks == true
-    runs-on: ${{ inputs.runs-on && fromJson(inputs.runs-on) || 'ubuntu-latest' }}
-    container: *container-setup
-    # jscpd:ignore-start
+  lint-container:
+    if: ${{ inputs.checks == true && inputs.lint && inputs.container != '' }}
+    permissions:
+      contents: read
+      # FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
+      id-token: write
+    needs:
+      - prepare
+      - setup-container
+    name: *lint-name
+    runs-on: *ci-runner
+    container: *ci-container
+    steps: *lint-steps
+
+  build-host:
+    if: ${{ inputs.checks == true && inputs.container == '' }}
+    name: &build-name 🏗️ Build
+    runs-on: *ci-runner
     needs:
       - prepare
-      - setup
+      - setup-host
     permissions:
       contents: read
       # FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
       id-token: write
-    outputs:
+    outputs: &build-outputs
       artifact-id: ${{ steps.build.outputs.artifact-id }}
-    steps:
+    env:
+      BUILD_COMMANDS: ${{ needs.setup-host.outputs.build-commands }}
+      BUILD_ENV: ${{ needs.setup-host.outputs.build-env }}
+      BUILD_ARTIFACT: ${{ needs.setup-host.outputs.build-artifact }}
+    steps: &build-steps
       - uses: hoverkraft-tech/ci-github-common/actions/checkout@753288393de1f3d92f687a6761d236ca800f5306 # 0.28.1
-        if: needs.setup.outputs.build-commands && needs.prepare.outputs.container-image == null
+        if: env.BUILD_COMMANDS && inputs.container == ''
 
       # FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
       - id: oidc
-        if: needs.setup.outputs.build-commands
+        if: env.BUILD_COMMANDS
         uses: ChristopherHX/oidc@73eee1ff03fdfce10eda179f617131532209edbd # v3
       - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-        if: needs.setup.outputs.build-commands
+        if: env.BUILD_COMMANDS
         with:
           path: ./self-workflow
           repository: ${{ steps.oidc.outputs.job_workflow_repo_name_and_owner }}
           ref: ${{ steps.oidc.outputs.job_workflow_repo_ref }}
           sparse-checkout: |
             actions
-      - if: needs.setup.outputs.build-commands
+      - if: env.BUILD_COMMANDS
         run: |
           if [ -f .gitignore ]; then grep -q "self-workflow" .gitignore || echo "self-workflow" >> .gitignore; else echo "self-workflow" >> .gitignore; fi
           if [ -f .dockerignore ]; then grep -q "self-workflow" .dockerignore || echo "self-workflow" >> .dockerignore; else echo "self-workflow" >> .dockerignore; fi
-      # jscpd:ignore-end
+
       - id: build
-        if: needs.setup.outputs.build-commands
+        if: env.BUILD_COMMANDS
         uses: ./self-workflow/actions/build
         with:
+          container: ${{ inputs.container != '' && 'true' || 'false' }}
           working-directory: ${{ inputs.working-directory }}
-          build-commands: ${{ needs.setup.outputs.build-commands }}
-          build-env: ${{ needs.setup.outputs.build-env }}
           build-secrets: ${{ secrets.build-secrets }}
-          build-artifact: ${{ needs.setup.outputs.build-artifact }}
-          container: ${{ needs.prepare.outputs.container-image && 'true' || 'false' }}
-
-  test:
-    name: 🧪 Test
-    if: inputs.checks == true && inputs.test
-    runs-on: ${{ inputs.runs-on && fromJson(inputs.runs-on) || 'ubuntu-latest' }}
-    container: *container-setup
+          build-commands: ${{ env.BUILD_COMMANDS }}
+          build-env: ${{ env.BUILD_ENV }}
+          build-artifact: ${{ env.BUILD_ARTIFACT }}
+
+  build-container:
+    if: ${{ inputs.checks == true && inputs.container != '' }}
+    permissions:
+      contents: read
+      # FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
+      id-token: write
     needs:
       - prepare
-      - setup
-      - build
+      - setup-container
+    env:
+      BUILD_COMMANDS: ${{ needs.setup-container.outputs.build-commands }}
+      BUILD_ENV: ${{ needs.setup-container.outputs.build-env }}
+      BUILD_ARTIFACT: ${{ needs.setup-container.outputs.build-artifact }}
+    name: *build-name
+    runs-on: *ci-runner
+    container: *ci-container
+    outputs: *build-outputs
+    steps: *build-steps
+
+  test-host:
+    if: ${{ inputs.checks == true && inputs.test && inputs.container == '' }}
+    name: &test-name 🧪 Test
+    runs-on: *ci-runner
+    needs:
+      - prepare
+      - setup-host
+      - build-host
     permissions:
       contents: read
       pull-requests: write
       # FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
       id-token: write
-    steps:
+    env:
+      BUILD_ARTIFACT_ID: ${{ needs.build-host.outputs.artifact-id }}
+    steps: &test-steps
       - uses: hoverkraft-tech/ci-github-common/actions/checkout@753288393de1f3d92f687a6761d236ca800f5306 # 0.28.1
-        if: needs.prepare.outputs.container-image == null
+        if: inputs.container == ''
 
-      - if: needs.build.outputs.artifact-id && needs.prepare.outputs.container-image == null
+      - if: env.BUILD_ARTIFACT_ID && inputs.container == ''
         uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
         with:
-          artifact-ids: ${{ needs.build.outputs.artifact-id }}
+          artifact-ids: ${{ env.BUILD_ARTIFACT_ID }}
           path: "/"
 
       # FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
@@ -575,22 +589,30 @@ jobs:
             core.setOutput('coverage-files', testOptions['coverage-files'] || '');
             core.setOutput('command', testOptions.command || 'test:ci');
 
-      - uses: ./self-workflow/actions/test
+      - name: Run tests
+        uses: ./self-workflow/actions/test
         with:
           working-directory: ${{ inputs.working-directory }}
-          container: ${{ needs.prepare.outputs.container-image && 'true' || 'false' }}
+          container: ${{ inputs.container != '' && '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
+  test-container:
+    if: ${{ inputs.checks == true && inputs.test && inputs.container != '' }}
+    needs:
+      - prepare
+      - setup-container
+      - build-container
+    permissions:
+      contents: read
+      pull-requests: write
+      # FIXME: This is a workaround for having workflow ref. See https://github.com/orgs/community/discussions/38659
+      id-token: write
+    env:
+      BUILD_ARTIFACT_ID: ${{ needs.build-container.outputs.artifact-id }}
+    name: *test-name
+    runs-on: *ci-runner
+    container: *ci-container
+    steps: *test-steps

tests/npm/package.json

@@ -3,6 +3,7 @@
   "main": "src/index.js",
   "scripts": {
     "lint": "echo \"lint test\"",
+    "lint:ci": "echo \"lint:ci test\"",
     "build": "mkdir -p dist && echo \"build test\" > dist/test.txt",
     "test:ci": "jest --coverage"
   },