docs: update actions and workflows documentation

hoverkraft-bot[bot] · hoverkraft-bot[bot] · commit ce750c78443e · 2025-11-20T13:19:31.000Z
[skip ci]

Signed-off-by: github-actions[bot] &lt;41898282+github-actions[bot]@users.noreply.github.com&gt;
diff --git a/.github/workflows/greetings.md b/.github/workflows/greetings.md
@@ -53,7 +53,7 @@ on:
 permissions: {}
 jobs:
   greetings:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@b9383df8d7fe98beca6aca1b51bce96189d0b93f # 0.28.2
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
     permissions:
       contents: read
       issues: write
diff --git a/.github/workflows/linter.md b/.github/workflows/linter.md
@@ -64,7 +64,7 @@ on:
 permissions: {}
 jobs:
   linter:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@b9383df8d7fe98beca6aca1b51bce96189d0b93f # 0.28.2
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
     permissions: {}
     secrets:
       # Token for marking the status of linter run in the Checks section.
diff --git a/.github/workflows/need-fix-to-issue.md b/.github/workflows/need-fix-to-issue.md
@@ -46,7 +46,7 @@ on:
 permissions: {}
 jobs:
   need-fix-to-issue:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml@b9383df8d7fe98beca6aca1b51bce96189d0b93f # 0.28.2
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
     permissions:
       contents: read
       issues: write
diff --git a/.github/workflows/semantic-pull-request.md b/.github/workflows/semantic-pull-request.md
@@ -51,7 +51,7 @@ on:
 permissions: {}
 jobs:
   semantic-pull-request:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@b9383df8d7fe98beca6aca1b51bce96189d0b93f # 0.28.2
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
     permissions:
       contents: write
       pull-requests: write
diff --git a/.github/workflows/stale.md b/.github/workflows/stale.md
@@ -45,7 +45,7 @@ on:
 permissions: {}
 jobs:
   stale:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@b9383df8d7fe98beca6aca1b51bce96189d0b93f # 0.28.2
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
     permissions:
       issues: write
       pull-requests: write
diff --git a/actions/checkout/README.md b/actions/checkout/README.md
@@ -43,7 +43,7 @@ permissions:
 ## Usage
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common/actions/checkout@b9383df8d7fe98beca6aca1b51bce96189d0b93f # 0.28.2
+- uses: hoverkraft-tech/ci-github-common/actions/checkout@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     # Number of commits to fetch. 0 indicates all history for all branches and tags.
     # See https://github.com/actions/checkout#usage
diff --git a/actions/create-and-merge-pull-request/README.md b/actions/create-and-merge-pull-request/README.md
@@ -37,7 +37,7 @@ See <https://docs.github.com/en/repositories/managing-your-repositorys-settings-
 ## Usage
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@b9383df8d7fe98beca6aca1b51bce96189d0b93f # 0.28.2
+- uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     # GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write).
     # See https://github.com/peter-evans/create-pull-request#action-inputs.
diff --git a/actions/create-or-update-comment/README.md b/actions/create-or-update-comment/README.md
@@ -41,7 +41,7 @@ permissions:
 ## Usage
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common/actions/create-or-update-comment@b9383df8d7fe98beca6aca1b51bce96189d0b93f # 0.28.2
+- uses: hoverkraft-tech/ci-github-common/actions/create-or-update-comment@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     # The comment title.
     # Must be static and unique, will be used to retrieve the comment if exists already.
diff --git a/actions/get-github-actions-bot-user/README.md b/actions/get-github-actions-bot-user/README.md
@@ -34,7 +34,7 @@ Usefull to commit, comment, etc.
 ## Usage
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common/actions/get-github-actions-bot-user@b9383df8d7fe98beca6aca1b51bce96189d0b93f # 0.28.2
+- uses: hoverkraft-tech/ci-github-common/actions/get-github-actions-bot-user@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
 ```
 
 <!-- usage:end -->
diff --git a/actions/get-issue-number/README.md b/actions/get-issue-number/README.md
@@ -33,7 +33,7 @@ Action to get Pull request or issue number
 ## Usage
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common/actions/get-issue-number@b9383df8d7fe98beca6aca1b51bce96189d0b93f # 0.28.2
+- uses: hoverkraft-tech/ci-github-common/actions/get-issue-number@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
 ```
 
 <!-- usage:end -->
diff --git a/actions/get-matrix-outputs/README.md b/actions/get-matrix-outputs/README.md
@@ -34,7 +34,7 @@ Workaround for <https://github.com/orgs/community/discussions/26639>.
 ## Usage
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common/actions/get-matrix-outputs@b9383df8d7fe98beca6aca1b51bce96189d0b93f # 0.28.2
+- uses: hoverkraft-tech/ci-github-common/actions/get-matrix-outputs@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     # The name of the artifact to download.
     # This input is required.
diff --git a/actions/parse-ci-reports/README.md b/actions/parse-ci-reports/README.md
@@ -55,7 +55,7 @@ It supports multiple common report standards out of the box.
 ## Usage
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@e6405b7d4daa7292edb246103f42b333a96d0a9f # copilot/add-report-parser-action
+- uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     # Paths to report files (glob patterns supported, one per line or comma-separated).
     # Set to `auto:test`, `auto:coverage`, `auto:lint`, or `auto:all` for automatic detection.
@@ -87,9 +87,12 @@ It supports multiple common report standards out of the box.
     # Path mapping(s) to rewrite file paths in reports (format: "from_path:to_path").
     # Useful when tests/lints run in a different directory or container.
     # Multiple mappings can be provided separated by newlines or commas.
-    # Examples: "/app/src:./src", "/app/src:./src,/app/tests:./tests"
-    #
-    # Default: ``
+    # Examples:
+    # - Single mapping: "/app/src:./src"
+    # - Multiple mappings: "/app/src:./src,/app/tests:./tests"
+    # - Multi-line: |
+    # /app/src:./src
+    # /app/tests:./tests
     path-mapping: ""
 ```
 
@@ -107,10 +110,15 @@ It supports multiple common report standards out of the box.
 | **`include-passed`** | Whether to include passed tests in the summary.                                                       | **false**    | `false`          |
 | **`output-format`**  | Output format: comma-separated list of `summary`, `markdown`, `annotations`, or `all` for everything. | **false**    | `all`            |
 | **`fail-on-error`**  | Whether to fail the action if any test failures are detected.                                         | **false**    | `false`          |
-| **`path-mapping`**   | Path mapping(s) to rewrite file paths in reports (format: `from_path:to_path`).                       | **false**    | `""`             |
+| **`path-mapping`**   | Path mapping(s) to rewrite file paths in reports (format: "from_path:to_path").                       | **false**    | -                |
 |                      | Useful when tests/lints run in a different directory or container.                                    |              |                  |
 |                      | Multiple mappings can be provided separated by newlines or commas.                                    |              |                  |
-|                      | Examples: `/app/src:./src`, `/app/src:./src,/app/tests:./tests`                                       |              |                  |
+|                      | Examples:                                                                                             |              |                  |
+|                      | - Single mapping: "/app/src:./src"                                                                    |              |                  |
+|                      | - Multiple mappings: "/app/src:./src,/app/tests:./tests"                                              |              |                  |
+|                      | - Multi-line: \|                                                                                      |              |                  |
+|                      | /app/src:./src                                                                                        |              |                  |
+|                      | /app/tests:./tests                                                                                    |              |                  |
 
 <!-- inputs:end -->
 <!-- secrets:start -->
@@ -121,7 +129,7 @@ It supports multiple common report standards out of the box.
 
 | **Output**         | **Description**                                 |
 | ------------------ | ----------------------------------------------- |
-| **`markdown`**     | Generated Markdown output for PR comments       |
+| **`markdown`**     | Generated markdown output for PR comments       |
 | **`summary`**      | Generated summary output                        |
 | **`parsed-files`** | List of parsed report files (JSON array)        |
 | **`has-errors`**   | Whether any errors were detected in the reports |
@@ -137,7 +145,7 @@ Let the action automatically find common report files:
 
 ```yaml
 - name: Parse all CI reports
-  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@e6405b7d4daa7292edb246103f42b333a96d0a9f # copilot/add-report-parser-action
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     report-paths: "auto:all"
     report-name: "CI Results"
@@ -147,7 +155,7 @@ Or target specific report types:
 
 ```yaml
 - name: Parse test reports only
-  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@e6405b7d4daa7292edb246103f42b333a96d0a9f # copilot/add-report-parser-action
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     report-paths: "auto:test"
     report-name: "Test Results"
@@ -168,7 +176,7 @@ Auto-detection modes:
 ```yaml
 - name: Parse test reports
   id: parse-reports
-  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@e6405b7d4daa7292edb246103f42b333a96d0a9f # copilot/add-report-parser-action
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     report-paths: "**/test-results/*.xml"
     report-name: "Test Results"
@@ -185,7 +193,7 @@ Auto-detection modes:
 
 ```yaml
 - name: Parse coverage
-  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@e6405b7d4daa7292edb246103f42b333a96d0a9f # copilot/add-report-parser-action
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     report-paths: "coverage/cobertura-coverage.xml"
     report-name: "Coverage Report"
@@ -196,7 +204,7 @@ Auto-detection modes:
 
 ```yaml
 - name: Parse test reports
-  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@e6405b7d4daa7292edb246103f42b333a96d0a9f # copilot/add-report-parser-action
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     report-paths: "**/junit.xml"
     report-name: "Test Results"
@@ -209,7 +217,7 @@ 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@e6405b7d4daa7292edb246103f42b333a96d0a9f # copilot/add-report-parser-action
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     report-paths: "auto:all"
     report-name: "CI Results"
@@ -222,7 +230,7 @@ Combine multiple output formats using comma-separated values:
 
 ```yaml
 - name: Parse reports with multiple outputs
-  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@e6405b7d4daa7292edb246103f42b333a96d0a9f # copilot/add-report-parser-action
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     report-paths: "auto:all"
     report-name: "CI Results"
@@ -233,7 +241,7 @@ Or use "all" for all output formats:
 
 ```yaml
 - name: Parse reports with all outputs
-  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@e6405b7d4daa7292edb246103f42b333a96d0a9f # copilot/add-report-parser-action
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     report-paths: "auto:test"
     report-name: "Test Results"
@@ -252,7 +260,7 @@ Parse test results, coverage, and linting in one action:
   run: npm run lint -- --format json --output-file eslint-report.json
 
 - name: Parse all reports
-  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@e6405b7d4daa7292edb246103f42b333a96d0a9f # copilot/add-report-parser-action
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     report-paths: |
       test-results/junit.xml
@@ -271,7 +279,7 @@ When running tests in a container or different directory, use path-mapping to en
     docker run --rm -v ${{ github.workspace }}:/app myimage npm test
 
 - name: Parse test reports
-  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@e6405b7d4daa7292edb246103f42b333a96d0a9f # copilot/add-report-parser-action
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     report-paths: "test-results/junit.xml"
     report-name: "Test Results"
@@ -287,7 +295,7 @@ When you have multiple source directories that need rewriting, provide multiple
 
 ```yaml
 - name: Parse reports with multiple path mappings
-  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@e6405b7d4daa7292edb246103f42b333a96d0a9f # copilot/add-report-parser-action
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     report-paths: "auto:all"
     report-name: "CI Results"
@@ -302,7 +310,7 @@ Or using comma-separated format:
 
 ```yaml
 - name: Parse reports with multiple path mappings
-  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@e6405b7d4daa7292edb246103f42b333a96d0a9f # copilot/add-report-parser-action
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     report-paths: "auto:all"
     report-name: "CI Results"
@@ -316,7 +324,7 @@ Another example for complex Docker overlay paths:
 
 ```yaml
 - name: Parse reports with path rewriting
-  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@e6405b7d4daa7292edb246103f42b333a96d0a9f # copilot/add-report-parser-action
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     report-paths: "auto:all"
     report-name: "CI Results"
@@ -330,7 +338,7 @@ Only comment on PRs if there are failures:
 ```yaml
 - name: Parse test reports
   id: parse-reports
-  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@e6405b7d4daa7292edb246103f42b333a96d0a9f # copilot/add-report-parser-action
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     report-paths: "**/test-results/*.xml"
     report-name: "Test Results"
@@ -356,7 +364,7 @@ Only comment on PRs if there are failures:
   run: mvn test
 
 - name: Parse all test reports
-  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@e6405b7d4daa7292edb246103f42b333a96d0a9f # copilot/add-report-parser-action
+  uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     report-paths: |
       pytest-results.xml
diff --git a/actions/repository-owner-is-organization/README.md b/actions/repository-owner-is-organization/README.md
@@ -33,7 +33,7 @@ Action to check if the repository owner is an organization.
 ## Usage
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common/actions/repository-owner-is-organization@b9383df8d7fe98beca6aca1b51bce96189d0b93f # 0.28.2
+- uses: hoverkraft-tech/ci-github-common/actions/repository-owner-is-organization@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     # GitHub token for fetching users API.
     # Default: `${{ github.token }}`
diff --git a/actions/set-matrix-output/README.md b/actions/set-matrix-output/README.md
@@ -38,7 +38,7 @@ This strategy effectively prevents any clashes or overwrites, maintaining the in
 ## Usage
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common/actions/set-matrix-output@b9383df8d7fe98beca6aca1b51bce96189d0b93f # 0.28.2
+- uses: hoverkraft-tech/ci-github-common/actions/set-matrix-output@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     # The matrix output to set.
     # This input is required.
diff --git a/actions/slugify/README.md b/actions/slugify/README.md
@@ -33,7 +33,7 @@ Action to slugify a given string value.
 ## Usage
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common/actions/slugify@b9383df8d7fe98beca6aca1b51bce96189d0b93f # 0.28.2
+- uses: hoverkraft-tech/ci-github-common/actions/slugify@d95c78dc4b10250a07e227d3ddf33b0ea093e28d # 0.29.0
   with:
     # The value to slugify.
     # This input is required.
