docs: update actions and workflows documentation

[skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
hoverkraft-tech · Apr 10, 2024 · 02b0389 · 02b0389
1 parent 993bf11
commit 02b0389
Show file tree

Hide file tree

Showing 16 changed files with 28 additions and 25 deletions.
diff --git a/.github/workflows/generate-dependabot-config.md b/.github/workflows/generate-dependabot-config.md
@@ -30,7 +30,7 @@ permissions:
 
 jobs:
   main:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/generate-dependabot-config.yml@0.13.1
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/generate-dependabot-config.yml@0.13.2
     with:
       # GitHub App ID to generate GitHub token in place of github-token.
       # See https://github.com/actions/create-github-app-token

diff --git a/.github/workflows/greetings.md b/.github/workflows/greetings.md
@@ -36,7 +36,7 @@ permissions:
 
 jobs:
   greetings:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@0.13.1
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@0.13.2
     secrets:
       # Token for the repository.
       # See https://github.com/actions/first-interaction#usage

diff --git a/.github/workflows/linter.md b/.github/workflows/linter.md
@@ -34,7 +34,7 @@ permissions:
 
 jobs:
   main:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@0.13.1
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@0.13.2
     secrets:
       # Token for marking the status of linter run in the Checks section.
       # See https://github.com/super-linter/super-linter#how-to-use

diff --git a/.github/workflows/need-fix-to-issue.md b/.github/workflows/need-fix-to-issue.md
@@ -40,7 +40,7 @@ permissions:
 
 jobs:
   main:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml@0.13.1
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml@0.13.2
     with:
       manual-commit-ref: ${{ inputs.manual-commit-ref }}
       manual-base-ref: ${{ inputs.manual-base-ref }}

diff --git a/.github/workflows/release-actions.md b/.github/workflows/release-actions.md
@@ -41,7 +41,7 @@ concurrency:
 
 jobs:
   release:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/release-actions.yml@0.13.1
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/release-actions.yml@0.13.2
     with:
       # Update all actions and workflows, regardless of changes.
       update-all: false

diff --git a/.github/workflows/semantic-pull-request.md b/.github/workflows/semantic-pull-request.md
@@ -36,7 +36,7 @@ permissions:
 
 jobs:
   main:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@0.13.1
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@0.13.2
     secrets:
       # Token for the repository.
       # Default GITHUB_TOKEN

diff --git a/.github/workflows/stale.md b/.github/workflows/stale.md
@@ -30,7 +30,7 @@ permissions:
 
 jobs:
   main:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@0.13.1
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@0.13.2
 
     # Optional customizations.
     with:

diff --git a/actions/checkout/README.md b/actions/checkout/README.md
@@ -33,7 +33,7 @@ permissions:
 <!-- start usage -->
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common@0.13.1
+- uses: hoverkraft-tech/ci-github-common@0.13.2
   with:
     # Description: Number of commits to fetch. 0 indicates all history for all
     # branches and tags. See

diff --git a/actions/create-and-merge-pull-request/README.md b/actions/create-and-merge-pull-request/README.md
@@ -9,6 +9,9 @@
 
 <!-- end branding -->
 <!-- start badges -->
+
+<a href="https%3A%2F%2Fgit.luolix.top%2Fhoverkraft-tech%2Fci-github-common%2Freleases%2Flatest"><img src="https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-common?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20tag" /></a><a href="https%3A%2F%2Fgit.luolix.top%2Fhoverkraft-tech%2Fci-github-common%2Freleases%2Flatest"><img src="https://img.shields.io/github/release-date/hoverkraft-tech/ci-github-common?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20date" /></a><img src="https://img.shields.io/github/last-commit/hoverkraft-tech/ci-github-common?logo=github&style=flat-square" alt="Commit" /><a href="https%3A%2F%2Fgit.luolix.top%2Fhoverkraft-tech%2Fci-github-common%2Fissues"><img src="https://img.shields.io/github/issues/hoverkraft-tech/ci-github-common?logo=github&style=flat-square" alt="Open%20Issues" /></a><img src="https://img.shields.io/github/downloads/hoverkraft-tech/ci-github-common/total?logo=github&style=flat-square" alt="Downloads" />
+
 <!-- end badges -->
 <!-- start description -->
 
@@ -27,11 +30,11 @@ Allow GitHub Actions to create and approve pull requests](https://docs.github.co
 <!-- start usage -->
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common@0.13.1
+- uses: hoverkraft-tech/ci-github-common@0.13.2
   with:
     # Description: 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.
+    # contents: write and pull-requests: write). See
+    # https://github.com/peter-evans/create-pull-request#action-inputs.
     #
     # Default: ${{ github.token }}
     github-token: ""
@@ -59,13 +62,13 @@ Allow GitHub Actions to create and approve pull requests](https://docs.github.co
 
 <!-- start inputs -->
 
-| **Input**                   | **Description**                                                                                                                                                                    | **Default**                      | **Required** |
-| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------ |
-| <code>github-token</code>   | 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>. | <code>${{ github.token }}</code> | **false**    |
-| <code>branch</code>         | The pull request branch name                                                                                                                                                       |                                  | **true**     |
-| <code>title</code>          | The pull request title                                                                                                                                                             |                                  | **true**     |
-| <code>body</code>           | The pull request body                                                                                                                                                              |                                  | **true**     |
-| <code>commit-message</code> | The commit message for the pull request                                                                                                                                            |                                  | **true**     |
+| **Input**                   | **Description**                                                                                                                                                                  | **Default**                      | **Required** |
+| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------ |
+| <code>github-token</code>   | 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. | <code>${{ github.token }}</code> | **false**    |
+| <code>branch</code>         | The pull request branch name                                                                                                                                                     |                                  | **true**     |
+| <code>title</code>          | The pull request title                                                                                                                                                           |                                  | **true**     |
+| <code>body</code>           | The pull request body                                                                                                                                                            |                                  | **true**     |
+| <code>commit-message</code> | The commit message for the pull request                                                                                                                                          |                                  | **true**     |
 
 <!-- end inputs -->
 <!-- start outputs -->

diff --git a/actions/create-or-update-comment/README.md b/actions/create-or-update-comment/README.md
@@ -32,7 +32,7 @@ permissions:
 <!-- start usage -->
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common@0.13.1
+- uses: hoverkraft-tech/ci-github-common@0.13.2
   with:
     # Description: 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
@@ -23,7 +23,7 @@ Action to get the GitHub Actions bot user informations. Usefull to commit, comme
 <!-- start usage -->
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common@0.13.1
+- uses: hoverkraft-tech/ci-github-common@0.13.2
   with:
 ```
 

diff --git a/actions/get-issue-number/README.md b/actions/get-issue-number/README.md
@@ -23,7 +23,7 @@ Action to get Pull request or issue number
 <!-- start usage -->
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common@0.13.1
+- uses: hoverkraft-tech/ci-github-common@0.13.2
   with:
 ```
 

diff --git a/actions/get-matrix-outputs/README.md b/actions/get-matrix-outputs/README.md
@@ -23,7 +23,7 @@ Download matrix ouputs from artifacts, because GitHub action does not handle job
 <!-- start usage -->
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common@0.13.1
+- uses: hoverkraft-tech/ci-github-common@0.13.2
   with:
     # Description: The name of the artifact to download.
     #

diff --git a/actions/repository-owner-is-organization/README.md b/actions/repository-owner-is-organization/README.md
@@ -23,7 +23,7 @@ Action to check if the repository owner is an organization.
 <!-- start usage -->
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common@0.13.1
+- uses: hoverkraft-tech/ci-github-common@0.13.2
   with:
     # Description: GitHub token for fetching users API.
     #

diff --git a/actions/set-matrix-output/README.md b/actions/set-matrix-output/README.md
@@ -28,7 +28,7 @@ This strategy effectively prevents any clashes or overwrites, maintaining the in
 <!-- start usage -->
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common@0.13.1
+- uses: hoverkraft-tech/ci-github-common@0.13.2
   with:
     # Description: The matrix output to set.
     #

diff --git a/actions/slugify/README.md b/actions/slugify/README.md
@@ -23,7 +23,7 @@ Action to slugify a given string value
 <!-- start usage -->
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common@0.13.1
+- uses: hoverkraft-tech/ci-github-common@0.13.2
   with:
     # Description: The value to slugify
     #