Add docker/action.yml to allow setting docker registry and image (#688)

Fixes #685.

Author: EnricoMi

.github/workflows/publish.yml

@@ -75,7 +75,7 @@ jobs:
           load: true
           push: false
           platforms: linux/${{ matrix.arch }}
-          tags: enricomi/publish-unit-test-result-action:latest
+          tags: local/enricomi/publish-unit-test-result-action:latest
           outputs: type=docker
         env:
           DOCKER_BUILD_RECORD_UPLOAD: false
@@ -88,110 +88,17 @@ jobs:
       - name: Publish Test Results
         id: test-results
         if: (!cancelled())
-        env:
-          INPUT_GITHUB_TOKEN: ${{ github.token }}
-          INPUT_CHECK_NAME: Test Results (Docker Image ${{ matrix.arch }})
-          INPUT_FILES: "artifacts/**/*.xml"
-          INPUT_JSON_FILE: "tests.json"
-          INPUT_JSON_SUITE_DETAILS: true
-          INPUT_JSON_TEST_CASE_RESULTS: true
-          INPUT_REPORT_SUITE_LOGS: "any"
-        run: |
-          docker run --platform linux/${{ matrix.arch }} \
-            --workdir $GITHUB_WORKSPACE \
-            --rm \
-            -e "INPUT_CHECK_NAME" \
-            -e "INPUT_JSON_FILE" \
-            -e "INPUT_JSON_SUITE_DETAILS" \
-            -e "INPUT_JSON_TEST_CASE_RESULTS" \
-            -e "INPUT_LOG_LEVEL" \
-            -e "INPUT_ROOT_LOG_LEVEL" \
-            -e "INPUT_GITHUB_TOKEN" \
-            -e "INPUT_GITHUB_RETRIES" \
-            -e "INPUT_SSL_VERIFY" \
-            -e "INPUT_COMMIT" \
-            -e "INPUT_COMMENT_TITLE" \
-            -e "INPUT_COMMENT_MODE" \
-            -e "INPUT_FAIL_ON" \
-            -e "INPUT_ACTION_FAIL" \
-            -e "INPUT_ACTION_FAIL_ON_INCONCLUSIVE" \
-            -e "INPUT_FILES" \
-            -e "INPUT_JUNIT_FILES" \
-            -e "INPUT_NUNIT_FILES" \
-            -e "INPUT_XUNIT_FILES" \
-            -e "INPUT_TRX_FILES" \
-            -e "INPUT_TIME_UNIT" \
-            -e "INPUT_TEST_FILE_PREFIX" \
-            -e "INPUT_REPORT_INDIVIDUAL_RUNS" \
-            -e "INPUT_REPORT_SUITE_LOGS" \
-            -e "INPUT_DEDUPLICATE_CLASSES_BY_FILE_NAME" \
-            -e "INPUT_LARGE_FILES" \
-            -e "INPUT_IGNORE_RUNS" \
-            -e "INPUT_CHECK_RUN" \
-            -e "INPUT_JOB_SUMMARY" \
-            -e "INPUT_COMPARE_TO_EARLIER_COMMIT" \
-            -e "INPUT_PULL_REQUEST_BUILD" \
-            -e "INPUT_EVENT_FILE" \
-            -e "INPUT_EVENT_NAME" \
-            -e "INPUT_TEST_CHANGES_LIMIT" \
-            -e "INPUT_CHECK_RUN_ANNOTATIONS" \
-            -e "INPUT_CHECK_RUN_ANNOTATIONS_BRANCH" \
-            -e "INPUT_SECONDS_BETWEEN_GITHUB_READS" \
-            -e "INPUT_SECONDS_BETWEEN_GITHUB_WRITES" \
-            -e "INPUT_SECONDARY_RATE_LIMIT_WAIT_SECONDS" \
-            -e "INPUT_JSON_THOUSANDS_SEPARATOR" \
-            -e "INPUT_SEARCH_PULL_REQUESTS" \
-            -e "HOME" \
-            -e "GITHUB_JOB" \
-            -e "GITHUB_REF" \
-            -e "GITHUB_SHA" \
-            -e "GITHUB_REPOSITORY" \
-            -e "GITHUB_REPOSITORY_OWNER" \
-            -e "GITHUB_RUN_ID" \
-            -e "GITHUB_RUN_NUMBER" \
-            -e "GITHUB_RETENTION_DAYS" \
-            -e "GITHUB_RUN_ATTEMPT" \
-            -e "GITHUB_ACTOR" \
-            -e "GITHUB_TRIGGERING_ACTOR" \
-            -e "GITHUB_WORKFLOW" \
-            -e "GITHUB_HEAD_REF" \
-            -e "GITHUB_BASE_REF" \
-            -e "GITHUB_EVENT_NAME" \
-            -e "GITHUB_SERVER_URL" \
-            -e "GITHUB_API_URL" \
-            -e "GITHUB_GRAPHQL_URL" \
-            -e "GITHUB_REF_NAME" \
-            -e "GITHUB_REF_PROTECTED" \
-            -e "GITHUB_REF_TYPE" \
-            -e "GITHUB_WORKSPACE" \
-            -e "GITHUB_ACTION" \
-            -e "GITHUB_EVENT_PATH" \
-            -e "GITHUB_ACTION_REPOSITORY" \
-            -e "GITHUB_ACTION_REF" \
-            -e "GITHUB_PATH" \
-            -e "GITHUB_ENV" \
-            -e "GITHUB_STEP_SUMMARY" \
-            -e "GITHUB_STATE" \
-            -e "GITHUB_OUTPUT" \
-            -e "RUNNER_OS" \
-            -e "RUNNER_ARCH" \
-            -e "RUNNER_NAME" \
-            -e "RUNNER_TOOL_CACHE" \
-            -e "RUNNER_TEMP" \
-            -e "RUNNER_WORKSPACE" \
-            -e "ACTIONS_RUNTIME_URL" \
-            -e "ACTIONS_RUNTIME_TOKEN" \
-            -e "ACTIONS_CACHE_URL" \
-            -e GITHUB_ACTIONS=true \
-            -e CI=true \
-            -v "$RUNNER_TEMP":"$RUNNER_TEMP" \
-            -v "/var/run/docker.sock":"/var/run/docker.sock" \
-            -v "/home/runner/work/_temp/_github_home":"/github/home" \
-            -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" \
-            -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" \
-            -v "/home/runner/work/publish-unit-test-result-action/publish-unit-test-result-action":"$GITHUB_WORKSPACE" \
-            enricomi/publish-unit-test-result-action:latest
-        shell: bash
+        uses: ./docker
+        with:
+          check_name: Test Results (Docker Image ${{ matrix.arch }})
+          files: "artifacts/**/*.xml"
+          json_file: "tests.json"
+          json_suite_details: true
+          json_test_case_results: true
+          report_suite_logs: "any"
+          docker_registry: local
+          docker_tag: latest
+          log_level: DEBUG
 
       - name: JSON output
         uses: ./misc/action/json-output
@@ -204,7 +111,7 @@ jobs:
         uses: crazy-max/ghaction-container-scan@v3
         continue-on-error: true
         with:
-          image: enricomi/publish-unit-test-result-action:latest
+          image: local/enricomi/publish-unit-test-result-action:latest
           dockerfile: ./Dockerfile
           annotations: true
       - name: Upload SARIF artifact

README.md

@@ -356,6 +356,28 @@ and removal, and `skipped tests` to detect new skipped and un-skipped tests, as
 `check_run_annotations_branch` to contain your default branch.
 </details>
 
+<details>
+<summary>Options related to Docker</summary>
+
+You can control the Docker image used for the action as below. For this, you need to run the action as follows:
+
+```yaml
+- name: Publish Test Results
+  uses: EnricoMi/publish-unit-test-result-action/docker@v2
+  if: (!cancelled())
+  with:
+    docker_registry: ghcr.io
+    files: …
+```
+
+| Option            |               Default Value                | Description                                                                                                      |
+|:------------------|:------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------|
+| `docker_registry` |                 `ghcr.io`                  | The docker registry to pull the pre-built action from. Defaults to the Github registry `ghcr.io`.                |
+| `docker_image`    | `enricomi/publish-unit-test-result-action` | The docker image name to pull the pre-built action from. Defaults to `enricomi/publish-unit-test-result-action`. |
+| `docker_tag`      |      *The same version as in `uses:`*      | The docker tag to pull the pre-built action from. This is usually not needed.                                    |
+| `docker_platform` |                                            | The platform to use when pulling the docker image.                                                               |
+</details>
+
 ## JSON result
 
 The gathered test information are accessible as JSON via [GitHub Actions steps outputs](https://docs.github.com/en/actions/learn-github-actions/contexts#steps-context) string or JSON file.

docker/action-types.yml

@@ -0,0 +1,185 @@
+# See https://github.com/typesafegithub/github-actions-typing/
+inputs:
+  github_token:
+    type: string
+
+  github_token_actor:
+    type: string
+
+  github_retries:
+    type: integer
+
+  ssl_verify:
+    type: boolean
+
+  commit:
+    type: string
+
+  check_name:
+    type: string
+
+  comment_title:
+    type: string
+
+  comment_mode:
+    type: enum
+    allowed-values:
+      - always
+      - changes
+      - changes in failures
+      - changes in errors
+      - failures
+      - errors
+      - off
+
+  fail_on:
+    type: enum
+    allowed-values:
+      - nothing
+      - errors
+      - test failures
+
+  action_fail:
+    type: boolean
+
+  action_fail_on_inconclusive:
+    type: boolean
+
+  files:
+    type: list
+    separator: '\n'
+    list-item:
+      type: string
+
+  junit_files:
+    type: list
+    separator: '\n'
+    list-item:
+      type: string
+
+  nunit_files:
+    type: list
+    separator: '\n'
+    list-item:
+      type: string
+
+  xunit_files:
+    type: list
+    separator: '\n'
+    list-item:
+      type: string
+
+  trx_files:
+    type: list
+    separator: '\n'
+    list-item:
+      type: string
+
+  time_unit:
+    type: enum
+    allowed-values:
+      - seconds
+      - milliseconds
+
+  test_file_prefix:
+    type: string
+
+  report_individual_runs:
+    type: boolean
+
+  report_suite_logs:
+    type: enum
+    allowed-values:
+      - info
+      - error
+      - any
+      - none
+
+  deduplicate_classes_by_file_name:
+    type: boolean
+
+  large_files:
+    type: boolean
+
+  ignore_runs:
+    type: boolean
+
+  check_run:
+    type: boolean
+
+  job_summary:
+    type: boolean
+
+  compare_to_earlier_commit:
+    type: boolean
+
+  pull_request_build:
+    type: enum
+    allowed-values:
+      - commit
+      - merge
+
+  event_file:
+    type: string
+
+  event_name:
+    type: string
+
+  test_changes_limit:
+    type: integer
+
+  check_run_annotations:
+    type: list
+    separator: ','
+    list-item:
+      type: enum
+      allowed-values:
+        - all tests
+        - skipped tests
+        - none
+
+  check_run_annotations_branch:
+    type: list
+    separator: ','
+    list-item:
+      type: string
+
+  seconds_between_github_reads:
+    type: float
+
+  seconds_between_github_writes:
+    type: float
+
+  secondary_rate_limit_wait_seconds:
+    type: float
+
+  json_file:
+    type: string
+
+  json_thousands_separator:
+    type: string
+
+  json_suite_details:
+    type: boolean
+
+  json_test_case_results:
+    type: boolean
+
+  search_pull_requests:
+    type: boolean
+
+  docker_platform:
+    type: string
+
+  docker_registry:
+    type: string
+
+  docker_image:
+    type: string
+
+  docker_tag:
+    type: string
+
+outputs:
+  json:
+    type: string