. | | | |
+| **`codeql-languages`** | JSON array of languages to analyze with CodeQL. | **false** | **string** | `["actions"]` |
+| | See . | | | |
+| | Leave empty to disable the check. | | | |
+| **`action-files`** | List of files or directories where GitHub Actions and workflows are located. | **false** | **string** | ./action.yml
./.github/workflows/\*\*/\*.yml
./actions/\*\*/\*.yml
|
+| | Supports glob patterns. | | | |
+| | Leave empty to disable the check. | | | |
+| **`lint-all`** | Run checks on all files, not just the changed ones. | **false** | **boolean** | `${{ github.event_name != 'pull_request' }}` |
+
+
+
+
## Secrets
-
+| **Secret** | **Description** | **Required** |
+| ------------------ | ----------------------------------------------------------------- | ------------ |
+| **`github-token`** | Token for marking the status of linter run in the Checks section. | **false** |
+| | See . | |
+| | Default GITHUB_TOKEN. | |
-| **Secret** | **Description** | **Default** | **Required** |
-| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | ------------ |
-| **github-token** | Token for marking the status of linter run in the Checks section. See . | GITHUB_TOKEN | **false** |
+
-
+
+
-## Inputs
+
+
+
+
+
+
+
+## Contributing
+
+Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md) for more details.
+
+
+
+
+
+
+
+
+## License
+
+This project is licensed under the MIT License.
+
+SPDX-License-Identifier: MIT
+
+Copyright © 2025 hoverkraft-tech
+
+For more details, see the [license](http://choosealicense.com/licenses/mit/).
+
+
-
+
-| **Input** | **Description** | **Default** | **Type** | **Required** |
-| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------- | ------------ |
-| **runs-on** | JSON array of runner(s) to use. See . | ["ubuntu-latest"] | `string` | **false** |
-| **linter-env** | Environment variables in multilines format "key=value" to pass to the linter. See . | .github/workflows\nactions | `string` | **false** |
-| **codeql-languages** | JSON array of languages to analyze with CodeQL. See . Leave empty to disable the check. | ["actions"] | `string` | **false** |
-| **action-files** | List of files or directories where GitHub Actions and workflows are located. Supports glob patterns. Leave empty to disable the check. | ./action.yml\n./.github/workflows/\*\*/\*.yml\n./actions/\*\*/\*.yml | `string` | **false** |
-| **lint-all** | Run linter on all files, not just the changed ones. | github.event_name != 'pull_request' | `boolean` | **false** |
+---
-
+This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
-
-
-
-
+
+
diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml
index b1ff3d72..ad866897 100644
--- a/.github/workflows/linter.yml
+++ b/.github/workflows/linter.yml
@@ -1,29 +1,30 @@
-# Linter
-# ==========================
# Reusable workflow that performs linting on the codebase.
# Executes:
+#
# - [Super-Linter](https://github.com/super-linter/super-linter), with some opinionated defaults.
# - [CodeQL](https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql) to analyze the code.
-# - [Ratchet](https://github.com/sethvargo/ratchet) to check that Github Action versions are pinned.
+# - [Ratchet](https://github.com/sethvargo/ratchet) to check that GitHub Action versions are pinned.
on:
workflow_call:
inputs:
runs-on:
- description: "JSON array of runner(s) to use. See ."
+ description: |
+ JSON array of runner(s) to use.
+ See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job.
type: string
required: false
default: '["ubuntu-latest"]'
linter-env:
description: |
Environment variables in multilines format "key=value" to pass to the linter.
- See .
+ See https://github.com/super-linter/super-linter.
type: string
required: false
codeql-languages:
description: |
JSON array of languages to analyze with CodeQL.
- See .
+ See https://codeql.github.com/docs/codeql-overview/supported-languages-and-frameworks/.
Leave empty to disable the check.
type: string
required: false
@@ -49,7 +50,7 @@ on:
github-token:
description: |
Token for marking the status of linter run in the Checks section.
- See .
+ See https://github.com/super-linter/super-linter#how-to-use.
Default GITHUB_TOKEN.
permissions:
@@ -105,11 +106,11 @@ jobs:
steps:
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- - uses: github/codeql-action/init@192325c86100d080feab897ff886c34abd4c83a3 # v3.30.3
+ - uses: github/codeql-action/init@3599b3baa15b485a2e49ef411a7a4bb2452e7f93 # v3.30.5
with:
languages: ${{ matrix.language }}
- - uses: github/codeql-action/analyze@192325c86100d080feab897ff886c34abd4c83a3 # v3.30.3
+ - uses: github/codeql-action/analyze@3599b3baa15b485a2e49ef411a7a4bb2452e7f93 # v3.30.5
with:
category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/need-fix-to-issue.md b/.github/workflows/need-fix-to-issue.md
index 49d073cb..1eefffee 100644
--- a/.github/workflows/need-fix-to-issue.md
+++ b/.github/workflows/need-fix-to-issue.md
@@ -1,72 +1,154 @@
-
-
-
+
# GitHub Reusable Workflow: Need fix to Issue
-
-
-
-
+
+
+
runs-on** | JSON array of runner(s) to use. See . | ["ubuntu-latest"] | `string` | **false** |
-| **manual-commit-ref** | The SHA of the commit to get the diff for. | manual-base-ref** | By default, the commit entered above is compared to the one directly before it; to go back further, enter an earlier SHA here for. |
+
+
github-token** | Token for the repository. | **false** |
+
-
-
+
+
-## Inputs
+
+
+
+
+
+
+
+## Contributing
+
+Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md) for more details.
+
+
+
+
+
+
+
+
+## License
+
+This project is licensed under the MIT License.
+
+SPDX-License-Identifier: MIT
+
+Copyright © 2025 hoverkraft-tech
+
+For more details, see the [license](http://choosealicense.com/licenses/mit/).
+
+
-
+
-| **Input** | **Description** | **Default** | **Type** | **Required** |
-| ------------------------ | ------------------------------------------------------------------------------------------------------------------ | ----------------------------- | -------- | ------------ |
-| **runs-on** | JSON array of runner(s) to use. See . | ["ubuntu-latest"] | `string` | **false** |
+---
-
+This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
-
+
-
-
-
-
+
diff --git a/.github/workflows/semantic-pull-request.yml b/.github/workflows/semantic-pull-request.yml
index 5d49d8b6..37d85891 100644
--- a/.github/workflows/semantic-pull-request.yml
+++ b/.github/workflows/semantic-pull-request.yml
@@ -1,6 +1,5 @@
-# Semantic pull request
-# ==========================
# Workflow to ensure Pull Request provides semantic versionning assets:
+#
# - "Squash and merge" Pull Request strategy provides a valid commit message.
# Check that the title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
# Mainly using [action-semantic-pull-request](https://github.com/amannn/action-semantic-pull-request#installation), with some opinionated defaults.
@@ -17,13 +16,17 @@ on:
workflow_call:
inputs:
runs-on:
- description: "JSON array of runner(s) to use. See ."
+ description: |
+ JSON array of runner(s) to use.
+ See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job.
required: false
type: string
default: '["ubuntu-latest"]'
secrets:
github-token:
- description: "Token for the repository."
+ description: |
+ Token for the repository.
+ Default: GITHUB_TOKEN.
required: false
permissions:
diff --git a/.github/workflows/stale.md b/.github/workflows/stale.md
index da0bd850..8ec74a55 100644
--- a/.github/workflows/stale.md
+++ b/.github/workflows/stale.md
@@ -1,85 +1,170 @@
-
-
-
+
-# GitHub Reusable Workflow: Stale
+# GitHub Reusable Workflow: Mark stale issues and pull requests
-
-
-
-
+
+
+
runs-on** | JSON array of runner(s) to use. See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job) | ["ubuntu-latest"] | **false** |
-| **stale-issue-message** | Comment on the staled issues. See [https://github.com/actions/stale#stale-issue-message](https://github.com/actions/stale#stale-issue-message) | This issue is stale | **false** |
-| **stale-pr-message** | Comment on the staled PRs. See [https://github.com/actions/stale#stale-pr-message](https://github.com/actions/stale#stale-pr-message) | This PR is stale | **false** |
-| **stale-issue-label** | Label to apply on staled issues. See [https://github.com/actions/stale#stale-issue-label](https://github.com/actions/stale#stale-issue-label) | no-issue-activity | **false** |
-| **exempt-issue-labels** | Labels on issues exempted from stale. See [https://github.com/actions/stale#exempt-issue-labels](https://github.com/actions/stale#exempt-issue-labels) | awaiting-approval,work-in-progress | **false** |
-| **stale-pr-label** | Label to apply on staled PRs. See [https://github.com/actions/stale#stale-pr-label](https://github.com/actions/stale#stale-pr-label) | no-pr-activity | **false** |
-| **exempt-pr-labels** | Labels on PRs exempted from stale. See [https://github.com/actions/stale#exempt-pr-labels](https://github.com/actions/stale#exempt-pr-labels) | awaiting-approval,work-in-progress | **false** |
-
-
-
-
-
-
+
+
+
+
+## Inputs
+
+### Workflow Call Inputs
+
+| **Input** | **Description** | **Required** | **Type** | **Default** |
+| ------------------------- | ---------------------------------------------------------------------------------- | ------------ | ---------- | ------------------- |
+| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` |
+| | See . | | | |
+| **`stale-issue-message`** | Comment on the staled issues. | **false** | **string** | - |
+| | See . | | | |
+| | Default: This issue is stale | | | |
+| **`stale-pr-message`** | Comment on the staled PRs. | **false** | **string** | - |
+| | See . | | | |
+| | Default: This PR is stale | | | |
+| **`stale-issue-label`** | Label to apply on staled issues. | **false** | **string** | - |
+| | See . | | | |
+| | Default: no-issue-activity | | | |
+| **`exempt-issue-labels`** | Labels on issues exempted from stale. | **false** | **string** | - |
+| | See . | | | |
+| | Default: awaiting-approval,work-in-progress | | | |
+| **`stale-pr-label`** | Label to apply on staled PRs. | **false** | **string** | - |
+| | See . | | | |
+| | Default: no-pr-activity | | | |
+| **`exempt-pr-labels`** | Labels on PRs exempted from stale. | **false** | **string** | - |
+| | See . | | | |
+| | Default: awaiting-approval,work-in-progress | | | |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Contributing
+
+Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md) for more details.
+
+
+
+
+
+
+
+
+## License
+
+This project is licensed under the MIT License.
+
+SPDX-License-Identifier: MIT
+
+Copyright © 2025 hoverkraft-tech
+
+For more details, see the [license](http://choosealicense.com/licenses/mit/).
+
+
+
+
+
+---
+
+This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
+
+
+
+
diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
index 5425eb94..12aa59b6 100644
--- a/.github/workflows/stale.yml
+++ b/.github/workflows/stale.yml
@@ -1,5 +1,3 @@
-# Stale
-# ==========================
# Reusable workflow to manage stale issues and pull requests.
# Mainly using [Stale Action](https://github.com/actions/stale), with some opinionated defaults.
@@ -12,32 +10,52 @@ on:
workflow_call:
inputs:
runs-on:
- description: "JSON array of runner(s) to use. See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job"
+ description: |
+ JSON array of runner(s) to use.
+ See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job.
type: string
default: '["ubuntu-latest"]'
required: false
stale-issue-message:
- description: "Comment on the staled issues. See https://github.com/actions/stale#stale-issue-message"
+ description: |
+ Comment on the staled issues.
+ See https://github.com/actions/stale#stale-issue-message.
+ Default: This issue is stale
type: string
required: false
stale-pr-message:
- description: "Comment on the staled PRs. See https://github.com/actions/stale#stale-pr-message"
+ description: |
+ Comment on the staled PRs.
+ See https://github.com/actions/stale#stale-pr-message.
+ Default: This PR is stale
type: string
required: false
stale-issue-label:
- description: "Label to apply on staled issues. See https://github.com/actions/stale#stale-issue-label"
+ description: |
+ Label to apply on staled issues.
+ See https://github.com/actions/stale#stale-issue-label.
+ Default: no-issue-activity
type: string
required: false
exempt-issue-labels:
- description: "Labels on issues exempted from stale. See https://github.com/actions/stale#exempt-issue-labels"
+ description: |
+ Labels on issues exempted from stale.
+ See https://github.com/actions/stale#exempt-issue-labels.
+ Default: awaiting-approval,work-in-progress
type: string
required: false
stale-pr-label:
- description: "Label to apply on staled PRs. See https://github.com/actions/stale#stale-pr-label"
+ description: |
+ Label to apply on staled PRs.
+ See https://github.com/actions/stale#stale-pr-label.
+ Default: no-pr-activity
type: string
required: false
exempt-pr-labels:
- description: "Labels on PRs exempted from stale. See https://github.com/actions/stale#exempt-pr-labels"
+ description: |
+ Labels on PRs exempted from stale.
+ See https://github.com/actions/stale#exempt-pr-labels.
+ Default: awaiting-approval,work-in-progress
type: string
required: false
diff --git a/Dockerfile b/Dockerfile
index 0456d588..e043adbb 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,5 +1,5 @@
#checkov:skip=CKV_DOCKER_2: required
-FROM ghcr.io/super-linter/super-linter:slim-v8
+FROM ghcr.io/super-linter/super-linter:slim-v8.0.0
ARG UID=1000
ARG GID=1000
diff --git a/actions/checkout/README.md b/actions/checkout/README.md
index 9d092eb9..b9718998 100644
--- a/actions/checkout/README.md
+++ b/actions/checkout/README.md
@@ -1,28 +1,33 @@
-
+
-# 
GitHub Action: Checkout
+#  GitHub Action: Checkout
-
-
-
-
+
+
+
+---
-
-
-
-
+
+
+
+
+[](https://github.com/marketplace/actions/checkout)
+[](https://github.com/hoverkraft-tech/ci-github-common/releases)
+[](http://choosealicense.com/licenses/mit/)
+[](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-common?style=social)
+[](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md)
+
+
+
+
+
+## Overview
-Action to checkout the repository compatible for PRs, issues and push events. Workaround for [https://github.com/actions/checkout/issues/331](https://github.com/actions/checkout/issues/331)
+Action to checkout the repository compatible for PRs, issues and push events.
+Workaround for ](.
-
-
-
+
Set permissions to read contents and pull-requests. This is required to get the PR branch.
@@ -33,42 +38,93 @@ permissions:
pull-requests: read
```
-
+
+
+## Usage
```yaml
-- uses: hoverkraft-tech/ci-github-common@0.25.0
+- uses: hoverkraft-tech/ci-github-common/actions/checkout@d324c777132734fc988c79a74dff3ee0248835fc # 0.25.0
with:
- # Description: Number of commits to fetch. 0 indicates all history for all
- # branches and tags. See
- # [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage)
+ # Number of commits to fetch. 0 indicates all history for all branches and tags.
+ # See https://github.com/actions/checkout#usage
#
- # Default: 1
- fetch-depth: ""
+ # Default: `1`
+ fetch-depth: "1"
- # Description: Whether to download Git-LFS files. See
- # [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage)
+ # Whether to download Git-LFS files.
+ # See https://github.com/actions/checkout#usage
#
- # Default: false
- lfs: ""
+ # Default: `false`
+ lfs: "false"
- # Description: Token to use for checking out the repository instead of the default
- # GITHUB_TOKEN. If specified and not empty, persist-credentials in checkout will
- # be false.
- #
+ # Token to use for checking out the repository instead of the default GITHUB_TOKEN.
+ # If specified and not empty, persist-credentials in checkout will be false.
token: ""
```
-
-
+
+
+
+
+## Inputs
+
+| **Input** | **Description** | **Required** | **Default** |
+| ----------------- | --------------------------------------------------------------------------------- | ------------ | ----------- |
+| **`fetch-depth`** | Number of commits to fetch. 0 indicates all history for all branches and tags. | **false** | `1` |
+| | See | | |
+| **`lfs`** | Whether to download Git-LFS files. | **false** | `false` |
+| | See | | |
+| **`token`** | Token to use for checking out the repository instead of the default GITHUB_TOKEN. | **false** | - |
+| | If specified and not empty, persist-credentials in checkout will be false. | | |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Contributing
+
+Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md) for more details.
+
+
+
+
+
+
+
+
+## License
+
+This project is licensed under the MIT License.
-| **Input** | **Description** | **Default** | **Required** |
-| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------------ |
-| fetch-depth | Number of commits to fetch. 0 indicates all history for all branches and tags. See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | 1 | **false** |
-| lfs | Whether to download Git-LFS files. See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | false | **false** |
-| token | Token to use for checking out the repository instead of the default GITHUB_TOKEN.
If specified and not empty, persist-credentials in checkout will be false. | | **false** |
+SPDX-License-Identifier: MIT
-
-
-
-
-
+Copyright © 2025 hoverkraft
+
+For more details, see the [license](http://choosealicense.com/licenses/mit/).
+
+
+
+
+
+---
+
+This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
+
+
+
+
diff --git a/actions/checkout/action.yml b/actions/checkout/action.yml
index d371ea6e..f1b5f61a 100644
--- a/actions/checkout/action.yml
+++ b/actions/checkout/action.yml
@@ -1,5 +1,7 @@
name: "Checkout"
-description: "Action to checkout the repository compatible for PRs, issues and push events. Workaround for [https://github.com/actions/checkout/issues/331](https://github.com/actions/checkout/issues/331)"
+description: |
+ Action to checkout the repository compatible for PRs, issues and push events.
+ Workaround for https://github.com/actions/checkout/issues/331](https://github.com/actions/checkout/issues/331.
author: hoverkraft
branding:
icon: git-branch
@@ -7,10 +9,14 @@ branding:
inputs:
fetch-depth:
- description: "Number of commits to fetch. 0 indicates all history for all branches and tags. See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage)"
+ description: |
+ Number of commits to fetch. 0 indicates all history for all branches and tags.
+ See https://github.com/actions/checkout#usage
default: "1"
lfs:
- description: "Whether to download Git-LFS files. See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage)"
+ description: |
+ Whether to download Git-LFS files.
+ See https://github.com/actions/checkout#usage
default: "false"
token:
description: |
diff --git a/actions/create-and-merge-pull-request/README.md b/actions/create-and-merge-pull-request/README.md
index aa0b9349..894f764b 100644
--- a/actions/create-and-merge-pull-request/README.md
+++ b/actions/create-and-merge-pull-request/README.md
@@ -1,76 +1,130 @@
-
-
+
-# GitHub Action: Create and merge Pull Request
+#  GitHub Action: Create and merge Pull Request
-
-
-
+
+
+
github-token | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write).
See . | ${{ github.token }} | **false** |
-| branch | The pull request branch name | | **true** |
-| title | The pull request title | | **true** |
-| body | The pull request body | | **true** |
-| commit-message | The commit message for the pull request | | **true** |
-
-
-
-
-
-
+| **Input** | **Description** | **Required** | **Default** |
+| -------------------- | ---------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
+| **`github-token`** | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write). | **false** | `${{ github.token }}` |
+| | See . | | |
+| **`branch`** | The pull request branch name | **true** | - |
+| **`title`** | The pull request title | **true** | - |
+| **`body`** | The pull request body | **true** | - |
+| **`commit-message`** | The commit message for the pull request | **true** | - |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Contributing
+
+Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md) for more details.
+
+
+
+
+
+
+
+
+## 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/).
+
+
+
+
+
+---
+
+This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
+
+
+
+
diff --git a/actions/create-and-merge-pull-request/action.yml b/actions/create-and-merge-pull-request/action.yml
index bd649dbd..91e8ee59 100644
--- a/actions/create-and-merge-pull-request/action.yml
+++ b/actions/create-and-merge-pull-request/action.yml
@@ -1,5 +1,9 @@
+# For this action to work you must explicitly allow GitHub Actions to create pull requests.
+# See https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.
name: "Create and merge Pull Request"
-description: "Action to create and merge Pull Request. Opinionated, set GitHub Actions bot as author, then rebase and merge."
+description: |
+ Action to create and merge Pull Request.
+ Opinionated, set GitHub Actions bot as author, then rebase and merge.
author: hoverkraft
branding:
icon: git-pull-request
@@ -9,7 +13,7 @@ inputs:
github-token:
description: |
GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write).
- See .
+ See https://github.com/peter-evans/create-pull-request#action-inputs.
default: ${{ github.token }}
required: false
branch:
@@ -57,7 +61,7 @@ runs:
- id: wait-for-pull-request-mergeable-by-admin
if: steps.create-pull-request.outputs.pull-request-number && steps.create-pull-request.outputs.pull-request-operation != 'closed'
- uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+ uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
with:
github-token: ${{ inputs.github-token }}
script: |
diff --git a/actions/create-or-update-comment/README.md b/actions/create-or-update-comment/README.md
index b9422a31..a964fd15 100644
--- a/actions/create-or-update-comment/README.md
+++ b/actions/create-or-update-comment/README.md
@@ -1,28 +1,32 @@
-
+
-# GitHub Action: Create or update comment
+#  GitHub Action: Create or update comment
-
-
-
-
+
+
+
title | The comment title. Must be static and unique, will be used to retrieve the comment if exists already. | | **true** |
-| body | The comment body. See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment) | | **false** |
-| reactions | A comma separated list of reactions to add to the comment. See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment) | | **false** |
-| comment-author | The comment author. Default is github-actions[bot]. | github-actions[bot] | **false** |
-| token | Optional token to interact with GitHub API.
If not defined or empty, the action will use the GITHUB_TOKEN provided by GitHub. | | **false** |
-
-
-
-
-
-
+
+
+
+
+## Inputs
+
+| **Input** | **Description** | **Required** | **Default** |
+| -------------------- | ---------------------------------------------------------------------------------- | ------------ | --------------------- |
+| **`title`** | The comment title. | **true** | - |
+| | Must be static and unique, will be used to retrieve the comment if exists already. | | |
+| **`body`** | The comment body. | **false** | - |
+| | See . | | |
+| **`reactions`** | A comma separated list of reactions to add to the comment. | **false** | - |
+| | See . | | |
+| **`comment-author`** | The comment author. | **false** | `github-actions[bot]` |
+| **`token`** | Optional token to interact with GitHub API. | **false** | - |
+| | If not defined or empty, the action will use the GITHUB_TOKEN provided by GitHub. | | |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Contributing
+
+Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md) for more details.
+
+
+
+
+
+
+
+
+## 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/).
+
+
+
+
+
+---
+
+This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
+
+
+
+
diff --git a/actions/create-or-update-comment/action.yml b/actions/create-or-update-comment/action.yml
index a63a8c55..1e67f20f 100644
--- a/actions/create-or-update-comment/action.yml
+++ b/actions/create-or-update-comment/action.yml
@@ -1,5 +1,5 @@
name: "Create or update comment"
-description: "Action to create or update comment in pull request or issue"
+description: "Action to create or update comment in pull request or issue."
author: hoverkraft
branding:
icon: message-square
@@ -7,16 +7,22 @@ branding:
inputs:
title:
- description: "The comment title. Must be static and unique, will be used to retrieve the comment if exists already."
+ description: |
+ The comment title.
+ Must be static and unique, will be used to retrieve the comment if exists already.
required: true
body:
- description: "The comment body. See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment)"
+ description: |
+ The comment body.
+ See https://github.com/peter-evans/create-or-update-comment.
required: false
reactions:
- description: "A comma separated list of reactions to add to the comment. See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment)"
+ description: |
+ A comma separated list of reactions to add to the comment.
+ See https://github.com/peter-evans/create-or-update-comment.
required: false
comment-author:
- description: "The comment author. Default is github-actions[bot]."
+ description: "The comment author."
required: false
default: "github-actions[bot]"
token:
diff --git a/actions/get-github-actions-bot-user/README.md b/actions/get-github-actions-bot-user/README.md
index d65dd550..798c8a7c 100644
--- a/actions/get-github-actions-bot-user/README.md
+++ b/actions/get-github-actions-bot-user/README.md
@@ -1,45 +1,107 @@
-
+
-# GitHub Action: Get GitHub Actions bot user
+#  GitHub Action: Get GitHub Actions bot user
+
+
+
+
email | The GitHub Actions bot user email. |
-| name | The GitHub Actions bot username. |
+SPDX-License-Identifier: MIT
-
-
-
+Copyright © 2025 hoverkraft
+
+For more details, see the [license](http://choosealicense.com/licenses/mit/).
+
+
+
+
+
+---
+
+This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
+
+
+
+
diff --git a/actions/get-github-actions-bot-user/action.yml b/actions/get-github-actions-bot-user/action.yml
index 817e5cf6..0efa561b 100644
--- a/actions/get-github-actions-bot-user/action.yml
+++ b/actions/get-github-actions-bot-user/action.yml
@@ -1,5 +1,7 @@
name: "Get GitHub Actions bot user"
-description: "Action to get the GitHub Actions bot user informations. Usefull to commit, comment, etc."
+description: |
+ Action to get the GitHub Actions bot user informations.
+ Usefull to commit, comment, etc.
author: hoverkraft
branding:
icon: user-check
diff --git a/actions/get-issue-number/README.md b/actions/get-issue-number/README.md
index a66447dc..079aed8d 100644
--- a/actions/get-issue-number/README.md
+++ b/actions/get-issue-number/README.md
@@ -1,44 +1,105 @@
-
+
-# GitHub Action: Get issue number
+#  GitHub Action: Get issue number
-
-
-
-
+
+
+
issue-number | The issue number. |
+
-
-
-
+## Outputs
+
+| **Output** | **Description** |
+| ------------------ | ----------------- |
+| **`issue-number`** | The issue number. |
+
+
+
+
+
+
+
+
+
+
+## Contributing
+
+Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md) for more details.
+
+
+
+
+
+
+
+
+## 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/).
+
+
+
+
+
+---
+
+This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
+
+
+
+
diff --git a/actions/get-matrix-outputs/README.md b/actions/get-matrix-outputs/README.md
index c3dc04f6..4ceeaed3 100644
--- a/actions/get-matrix-outputs/README.md
+++ b/actions/get-matrix-outputs/README.md
@@ -1,59 +1,116 @@
-
+
-# GitHub Action: Get matrix ouput
+#  GitHub Action: Get matrix ouput
-
-
+
+
+
artifact-name | The name of the artifact to download. | | **true** |
-| remove-artifact | Define weather to remove the downloaded artifact after reading. | true | **false** |
+
+
-
-
+
+
+
+
+## Contributing
+
+Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md) for more details.
+
+
+
+
+
+
+
+
+## License
+
+This project is licensed under the MIT License.
-| **Output** | **Description** |
-| ------------------- | --------------------------------- |
-| result | The matrix combined JSON outputs. |
+SPDX-License-Identifier: MIT
-
-
-
+Copyright © 2025 hoverkraft
+
+For more details, see the [license](http://choosealicense.com/licenses/mit/).
+
+
+
+
+
+---
+
+This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
+
+
+
+
diff --git a/actions/get-matrix-outputs/action.yml b/actions/get-matrix-outputs/action.yml
index 8be9c889..0a7314e7 100644
--- a/actions/get-matrix-outputs/action.yml
+++ b/actions/get-matrix-outputs/action.yml
@@ -1,8 +1,7 @@
-# Download matrix ouputs from artifacts, because github action does not handle job outputs for matrix
-# Workaround for https://github.com/orgs/community/discussions/26639
-
name: "Get matrix ouput"
-description: "Download matrix ouputs from artifacts, because GitHub Action does not handle job outputs for matrix"
+description: |
+ Download matrix ouputs from artifacts, because GitHub Action does not handle job outputs for matrix.
+ Workaround for https://github.com/orgs/community/discussions/26639.
author: hoverkraft
branding:
icon: download-cloud
@@ -41,7 +40,7 @@ runs:
merge-multiple: true
- id: read-artifacts
- uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+ uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
with:
script: |
const { readFileSync } = require('fs');
diff --git a/actions/repository-owner-is-organization/README.md b/actions/repository-owner-is-organization/README.md
index 25a85683..02603c47 100644
--- a/actions/repository-owner-is-organization/README.md
+++ b/actions/repository-owner-is-organization/README.md
@@ -1,53 +1,110 @@
-
+
-# GitHub Action: Repository owner is organization
+#  GitHub Action: Repository owner is organization
-
-
-
-
+
+
+
github-token | GitHub token for fetching users API. | ${{ github.token }} | **false** |
+
+
-
-
+
-| **Output** | **Description** |
-| ---------------------------- | ------------------------------------------------------------------------ |
-| is-organization | The boolean value indicating if the repository owner is an organization. |
+## Outputs
-
-
-
+| **Output** | **Description** |
+| --------------------- | ------------------------------------------------------------------------ |
+| **`is-organization`** | The boolean value indicating if the repository owner is an organization. |
+
+
+
+
+
+
+
+
+
+
+## Contributing
+
+Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md) for more details.
+
+
+
+
+
+
+
+
+## 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/).
+
+
+
+
+
+---
+
+This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
+
+
+
+
diff --git a/actions/set-matrix-output/README.md b/actions/set-matrix-output/README.md
index 36b05884..12c7603f 100644
--- a/actions/set-matrix-output/README.md
+++ b/actions/set-matrix-output/README.md
@@ -1,62 +1,120 @@
-
+
-# GitHub Action: Set matrix ouput
+#  GitHub Action: Set matrix ouput
-
-
-
-
+
+
+
value | The matrix output to set. | | **true** |
-| artifact-name | The name of the artifact to upload. | | **true** |
+
+
-
-
+
+
+
+
+## Contributing
+
+Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md) for more details.
+
+
+
+
+
+
+
+
+## License
+
+This project is licensed under the MIT License.
-| **Output** | **Description** |
-| -------------------------- | ---------------------------------------------- |
-| artifact-name | The real unique name of the uploaded artifact. |
+SPDX-License-Identifier: MIT
-
-
-
+Copyright © 2025 hoverkraft
+
+For more details, see the [license](http://choosealicense.com/licenses/mit/).
+
+
+
+
+
+---
+
+This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
+
+
+
+
diff --git a/actions/set-matrix-output/action.yml b/actions/set-matrix-output/action.yml
index 9bcd1f49..5028aa43 100644
--- a/actions/set-matrix-output/action.yml
+++ b/actions/set-matrix-output/action.yml
@@ -1,12 +1,11 @@
-# Set matrix ouput in file to be uploaded as artifacts, because github action does not handle job outputs for matrix
-# Workaround for https://github.com/orgs/community/discussions/26639
-
name: "Set matrix ouput"
-description: "Set matrix ouput in file to be uploaded as artifacts, because GitHub Action does not handle job outputs for matrix."
-author: Hoverkraft
+description: |
+ Set matrix ouput in file to be uploaded as artifacts, because GitHub Action does not handle job outputs for matrix.
+ Workaround for https://github.com/orgs/community/discussions/26639.
+author: hoverkraft
branding:
icon: upload-cloud
- color: gray-dark
+ color: blue
inputs:
value:
@@ -24,7 +23,7 @@ runs:
using: "composite"
steps:
- id: prepare-upload
- uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+ uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
with:
script: |
const { join } = require('path');
diff --git a/actions/slugify/README.md b/actions/slugify/README.md
index 5c65a2f4..eac93134 100644
--- a/actions/slugify/README.md
+++ b/actions/slugify/README.md
@@ -1,52 +1,110 @@
-
+
-# GitHub Action: Slugify
+#  GitHub Action: Slugify
-
-
-
-
+
+
+
value | The value to slugify | | **true** |
+
+
-
-
+
-| **Output** | **Description** |
-| ------------------- | ------------------- |
-| result | The slugified value |
+## Outputs
-
-
-
+| **Output** | **Description** |
+| ------------ | ------------------- |
+| **`result`** | The slugified value |
+
+
+
+
+
+
+
+
+
+
+## Contributing
+
+Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-common/blob/main/CONTRIBUTING.md) for more details.
+
+
+
+
+
+
+
+
+## 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/).
+
+
+
+
+
+---
+
+This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
+
+
+
+
diff --git a/actions/slugify/action.yml b/actions/slugify/action.yml
index 7def504c..0768e92b 100644
--- a/actions/slugify/action.yml
+++ b/actions/slugify/action.yml
@@ -1,5 +1,5 @@
name: "Slugify"
-description: "Action to slugify a given string value"
+description: "Action to slugify a given string value."
author: hoverkraft
branding:
icon: link-2
@@ -7,7 +7,7 @@ branding:
inputs:
value:
- description: "The value to slugify"
+ description: "The value to slugify."
required: true
outputs: