docs: update actions and workflows documentation

[skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
hoverkraft-tech · Mar 31, 2024 · a70cd49 · a70cd49
1 parent 8bff35d
commit a70cd49
Show file tree

Hide file tree

Showing 31 changed files with 1,065 additions and 91 deletions.
diff --git a/.github/workflows/generate-dependabot-config.md b/.github/workflows/generate-dependabot-config.md
@@ -26,7 +26,7 @@ on:
       - main
 jobs:
   main:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/generate-dependabot-config.yml@0.11.2
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/generate-dependabot-config.yml@0.12.1
     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/linter.md b/.github/workflows/linter.md
@@ -30,7 +30,7 @@ on:
 
 jobs:
   main:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@0.11.2
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@0.12.1
     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
@@ -35,7 +35,7 @@ on:
 
 jobs:
   main:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml@0.11.2
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml@0.12.1
     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
@@ -33,7 +33,7 @@ concurrency:
 
 jobs:
   release:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/release-actions.yml@0.11.2
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/release-actions.yml@0.12.1
     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
@@ -32,7 +32,7 @@ on:
 
 jobs:
   main:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@0.11.2
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@0.12.1
     secrets:
       # Token for the repository.
       # Default GITHUB_TOKEN

diff --git a/.github/workflows/stale.md b/.github/workflows/stale.md
@@ -26,7 +26,7 @@ on:
 
 jobs:
   main:
-    uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@0.12.0
+    uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@0.12.1
 
     # Optional customizations.
     with:

diff --git a/actions/checkout/README.md b/actions/checkout/README.md
@@ -1,11 +1,17 @@
 <!-- start branding -->
+
+<img src=".github/ghadocs/branding.svg" width="15%" align="center" alt="branding<icon:git-branch color:gray-dark>" />
+
 <!-- end branding -->
 <!-- start title -->
 
-# GitHub Action: Checkout
+# <img src=".github/ghadocs/branding.svg" width="60px" align="center" alt="branding<icon:git-branch color:gray-dark>" /> GitHub Action: Checkout
 
 <!-- end title -->
 <!-- start badges -->
+
+<a href="https%3A%2F%2Fgithub.com%2F%2Fci-github-common%2Factions%2Fcheckout%2Freleases%2Flatest"><img src="https://img.shields.io/github/v/release//ci-github-common/actions/checkout?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20tag" /></a><a href="https%3A%2F%2Fgithub.com%2F%2Fci-github-common%2Factions%2Fcheckout%2Freleases%2Flatest"><img src="https://img.shields.io/github/release-date//ci-github-common/actions/checkout?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20date" /></a><img src="https://img.shields.io/github/last-commit//ci-github-common/actions/checkout?logo=github&style=flat-square" alt="Commit" /><a href="https%3A%2F%2Fgithub.com%2F%2Fci-github-common%2Factions%2Fcheckout%2Fissues"><img src="https://img.shields.io/github/issues//ci-github-common/actions/checkout?logo=github&style=flat-square" alt="Open%20Issues" /></a><img src="https://img.shields.io/github/downloads//ci-github-common/actions/checkout/total?logo=github&style=flat-square" alt="Downloads" />
+
 <!-- end badges -->
 <!-- start description -->
 
@@ -27,25 +33,29 @@ permissions:
 <!-- start usage -->
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common/actions/checkout@v0.7.5
+- uses: /ci-github-common/actions/checkout@0.12.1
   with:
-    # 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](https://github.com/actions/checkout#usage)
+    #
     # Default: 1
     fetch-depth: ""
 
-    # 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](https://github.com/actions/checkout#usage)
+    #
     # Default: false
     lfs: ""
 ```
 
 <!-- end usage -->
 <!-- start inputs -->
 
-| **Input**                    | **Description**                                                                                                                                                           | **Default**    | **Required** |
-| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------------ |
-| **<code>fetch-depth</code>** | 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) | <code>1</code> | **false**    |
-| **<code>lfs</code>**         | Whether to download Git-LFS files. See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage)                                             |                | **false**    |
+| **Input**                | **Description**                                                                                                                                                           | **Default**    | **Required** |
+| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------------ |
+| <code>fetch-depth</code> | 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) | <code>1</code> | **false**    |
+| <code>lfs</code>         | Whether to download Git-LFS files. See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage)                                             |                | **false**    |
 
 <!-- end inputs -->
 <!-- start outputs -->

diff --git a/actions/create-and-merge-pull-request/README.md b/actions/create-and-merge-pull-request/README.md
@@ -1,11 +1,17 @@
 <!-- start branding -->
+
+<img src=".github/ghadocs/branding.svg" width="15%" align="center" alt="branding<icon:git-pull-request color:gray-dark>" />
+
 <!-- end branding -->
 <!-- start title -->
 
-# GitHub Action: Create and Merge Pull Request
+# <img src=".github/ghadocs/branding.svg" width="60px" align="center" alt="branding<icon:git-pull-request color:gray-dark>" /> GitHub Action: Create and merge Pull Request
 
 <!-- end title -->
 <!-- start badges -->
+
+<a href="https%3A%2F%2Fgithub.com%2F%2Fci-github-common%2Factions%2Fcreate-and-merge-pull-request%2Freleases%2Flatest"><img src="https://img.shields.io/github/v/release//ci-github-common/actions/create-and-merge-pull-request?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20tag" /></a><a href="https%3A%2F%2Fgithub.com%2F%2Fci-github-common%2Factions%2Fcreate-and-merge-pull-request%2Freleases%2Flatest"><img src="https://img.shields.io/github/release-date//ci-github-common/actions/create-and-merge-pull-request?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20date" /></a><img src="https://img.shields.io/github/last-commit//ci-github-common/actions/create-and-merge-pull-request?logo=github&style=flat-square" alt="Commit" /><a href="https%3A%2F%2Fgithub.com%2F%2Fci-github-common%2Factions%2Fcreate-and-merge-pull-request%2Fissues"><img src="https://img.shields.io/github/issues//ci-github-common/actions/create-and-merge-pull-request?logo=github&style=flat-square" alt="Open%20Issues" /></a><img src="https://img.shields.io/github/downloads//ci-github-common/actions/create-and-merge-pull-request/total?logo=github&style=flat-square" alt="Downloads" />
+
 <!-- end badges -->
 <!-- start description -->
 
@@ -21,36 +27,42 @@ Allow GitHub Actions to create and approve pull requests](https://docs.github.co
 <!-- start usage -->
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@v0.7.5
+- uses: /ci-github-common/actions/create-and-merge-pull-request@0.12.1
   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](https://github.com/peter-evans/create-pull-request#action-inputs)
+    # 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](https://github.com/peter-evans/create-pull-request#action-inputs)
+    #
     # Default: ${{ github.token }}
     github-token: ""
 
-    # The pull request branch name
+    # Description: The pull request branch name
+    #
     branch: ""
 
-    # The pull request title
+    # Description: The pull request title
+    #
     title: ""
 
-    # The pull request body
+    # Description: The pull request body
+    #
     body: ""
 
-    # The commit message for the pull request
+    # Description: The commit message for the pull request
+    #
     commit-message: ""
 ```
 
 <!-- end usage -->
 <!-- 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](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](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
@@ -1,11 +1,17 @@
 <!-- start branding -->
+
+<img src=".github/ghadocs/branding.svg" width="15%" align="center" alt="branding<icon:message-square color:gray-dark>" />
+
 <!-- end branding -->
 <!-- start title -->
 
-# GitHub Action: Create or Update Comment
+# <img src=".github/ghadocs/branding.svg" width="60px" align="center" alt="branding<icon:message-square color:gray-dark>" /> GitHub Action: Create or update comment
 
 <!-- end title -->
 <!-- start badges -->
+
+<a href="https%3A%2F%2Fgithub.com%2F%2Fci-github-common%2Factions%2Fcreate-or-update-comment%2Freleases%2Flatest"><img src="https://img.shields.io/github/v/release//ci-github-common/actions/create-or-update-comment?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20tag" /></a><a href="https%3A%2F%2Fgithub.com%2F%2Fci-github-common%2Factions%2Fcreate-or-update-comment%2Freleases%2Flatest"><img src="https://img.shields.io/github/release-date//ci-github-common/actions/create-or-update-comment?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20date" /></a><img src="https://img.shields.io/github/last-commit//ci-github-common/actions/create-or-update-comment?logo=github&style=flat-square" alt="Commit" /><a href="https%3A%2F%2Fgithub.com%2F%2Fci-github-common%2Factions%2Fcreate-or-update-comment%2Fissues"><img src="https://img.shields.io/github/issues//ci-github-common/actions/create-or-update-comment?logo=github&style=flat-square" alt="Open%20Issues" /></a><img src="https://img.shields.io/github/downloads//ci-github-common/actions/create-or-update-comment/total?logo=github&style=flat-square" alt="Downloads" />
+
 <!-- end badges -->
 <!-- start description -->
 
@@ -26,28 +32,32 @@ permissions:
 <!-- start usage -->
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-common/actions/create-or-update-comment@v0.7.5
+- uses: /ci-github-common/actions/create-or-update-comment@0.12.1
   with:
-    # 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.
+    #
     title: ""
 
-    # 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](https://github.com/peter-evans/create-or-update-comment)
+    #
     body: ""
 
-    # A comma separated list of reactions to add to the comment. See
+    # 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)
+    #
     reactions: ""
 ```
 
 <!-- end usage -->
 <!-- start inputs -->
 
-| **Input**                  | **Description**                                                                                                                                                                   | **Default** | **Required** |
-| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------ |
-| **<code>title</code>**     | The comment title. Must be static and unique, will be used to retrieve the comment if exists already.                                                                             |             | **true**     |
-| **<code>body</code>**      | The comment body. See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment)                                          |             | **false**    |
-| **<code>reactions</code>** | 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**    |
+| **Input**              | **Description**                                                                                                                                                                   | **Default** | **Required** |
+| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------ |
+| <code>title</code>     | The comment title. Must be static and unique, will be used to retrieve the comment if exists already.                                                                             |             | **true**     |
+| <code>body</code>      | The comment body. See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment)                                          |             | **false**    |
+| <code>reactions</code> | 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**    |
 
 <!-- end inputs -->
 <!-- start outputs -->