From 02b0389da2192d319171e9471aa89ace42001662 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Wed, 10 Apr 2024 07:34:40 +0000
Subject: [PATCH] docs: update actions and workflows documentation
[skip ci]
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
---
.../workflows/generate-dependabot-config.md | 2 +-
.github/workflows/greetings.md | 2 +-
.github/workflows/linter.md | 2 +-
.github/workflows/need-fix-to-issue.md | 2 +-
.github/workflows/release-actions.md | 2 +-
.github/workflows/semantic-pull-request.md | 2 +-
.github/workflows/stale.md | 2 +-
actions/checkout/README.md | 2 +-
.../create-and-merge-pull-request/README.md | 23 +++++++++++--------
actions/create-or-update-comment/README.md | 2 +-
actions/get-github-actions-bot-user/README.md | 2 +-
actions/get-issue-number/README.md | 2 +-
actions/get-matrix-outputs/README.md | 2 +-
.../README.md | 2 +-
actions/set-matrix-output/README.md | 2 +-
actions/slugify/README.md | 2 +-
16 files changed, 28 insertions(+), 25 deletions(-)
diff --git a/.github/workflows/generate-dependabot-config.md b/.github/workflows/generate-dependabot-config.md
index db7b1df..65c9699 100644
--- 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
index 368d2ad..8141cfa 100644
--- 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
index 7c3853f..d537eb5 100644
--- 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
index 66c2e16..b5735b8 100644
--- 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
index 1cc4ea6..8cd8f47 100644
--- 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
index cb788c6..bde2ebb 100644
--- 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
index 12e9b3c..9d7757a 100644
--- 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
index 990594a..9a941f2 100644
--- a/actions/checkout/README.md
+++ b/actions/checkout/README.md
@@ -33,7 +33,7 @@ permissions:
```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
index 3ed6f3b..c5141fe 100644
--- a/actions/create-and-merge-pull-request/README.md
+++ b/actions/create-and-merge-pull-request/README.md
@@ -9,6 +9,9 @@
+
+
+
@@ -27,11 +30,11 @@ Allow GitHub Actions to create and approve pull requests](https://docs.github.co
```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
-| **Input** | **Description** | **Default** | **Required** |
-| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------ |
-| 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** | **Default** | **Required** |
+| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------ |
+| github-token
| 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. | ${{ 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** |
diff --git a/actions/create-or-update-comment/README.md b/actions/create-or-update-comment/README.md
index c9fa407..242fcad 100644
--- a/actions/create-or-update-comment/README.md
+++ b/actions/create-or-update-comment/README.md
@@ -32,7 +32,7 @@ permissions:
```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
index 698e814..8692bd6 100644
--- 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
```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
index 0b54b82..2bcc400 100644
--- 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
```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
index 0adba69..57f1e3f 100644
--- 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
```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
index 283f0cf..67113ce 100644
--- 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.
```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
index 4ced426..750359f 100644
--- 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
```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
index 6f839e3..52a8023 100644
--- a/actions/slugify/README.md
+++ b/actions/slugify/README.md
@@ -23,7 +23,7 @@ Action to slugify a given string value
```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
#