Skip to content

Commit

Permalink
docs: update actions and workflows documentation
Browse files Browse the repository at this point in the history
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
github-actions[bot] committed Jun 18, 2024
1 parent 4356000 commit 7bdd1d6
Show file tree
Hide file tree
Showing 16 changed files with 41 additions and 76 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/generate-dependabot-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ permissions:

jobs:
main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].2
uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].3
with:
# GitHub App ID to generate GitHub token in place of github-token.
# See https://github.com/actions/create-github-app-token
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/greetings.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ permissions:

jobs:
greetings:
uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].2
uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].3
secrets:
# Token for the repository.
# See https://github.com/actions/first-interaction#usage
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/linter.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ permissions:

jobs:
main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].2
uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].3
secrets:
# Token for marking the status of linter run in the Checks section.
# See https://github.com/super-linter/super-linter#how-to-use
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/need-fix-to-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ permissions:

jobs:
main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].2
uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].3
with:
manual-commit-ref: ${{ inputs.manual-commit-ref }}
manual-base-ref: ${{ inputs.manual-base-ref }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ concurrency:

jobs:
release:
uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].2
uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].3
with:
# Update all actions and workflows, regardless of changes.
update-all: false
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/semantic-pull-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ permissions:

jobs:
main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].2
uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].3
secrets:
# Token for the repository.
# Default GITHUB_TOKEN
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/stale.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ permissions:

jobs:
main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].2
uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].3

# Optional customizations.
with:
Expand Down
10 changes: 3 additions & 7 deletions actions/checkout/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
<!-- 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 -->
<!--
// jscpd:ignore-start
-->
<!-- start badges -->

<a href="https%3A%2F%2Fgithub.com%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%2Fgithub.com%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%2Fgithub.com%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" />
<a href="https%3A%2F%2Fgithub.com%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%2Fgithub.com%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%2Fgithub.com%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 -->
<!--
Expand All @@ -38,7 +34,7 @@ permissions:
<!-- start usage -->
```yaml
- uses: hoverkraft-tech/[email protected].2
- uses: hoverkraft-tech/[email protected].3
with:
# Description: Number of commits to fetch. 0 indicates all history for all
# branches and tags. See
Expand Down
24 changes: 10 additions & 14 deletions actions/create-and-merge-pull-request/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
<!-- jscpd:ignore-start -->
<!-- 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%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%2Fgithub.com%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%2Fgithub.com%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" />
<a href="https%3A%2F%2Fgithub.com%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%2Fgithub.com%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%2Fgithub.com%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 -->
<!-- jscpd:ignore-end -->
Expand All @@ -31,7 +27,7 @@ Allow GitHub Actions to create and approve pull requests](https://docs.github.co
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/[email protected].2
- uses: hoverkraft-tech/[email protected].3
with:
# Description: GitHub token for creating and merging pull request (permissions
# contents: write and pull-requests: write). See
Expand Down Expand Up @@ -63,13 +59,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 -->
Expand Down
10 changes: 3 additions & 7 deletions actions/create-or-update-comment/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
<!-- 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 -->
<!--
// jscpd:ignore-start
-->
<!-- start badges -->

<a href="https%3A%2F%2Fgithub.com%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%2Fgithub.com%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%2Fgithub.com%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" />
<a href="https%3A%2F%2Fgithub.com%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%2Fgithub.com%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%2Fgithub.com%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 -->
<!--
Expand All @@ -37,7 +33,7 @@ permissions:
<!-- start usage -->
```yaml
- uses: hoverkraft-tech/[email protected].2
- uses: hoverkraft-tech/[email protected].3
with:
# Description: The comment title. Must be static and unique, will be used to
# retrieve the comment if exists already.
Expand Down
10 changes: 3 additions & 7 deletions actions/get-github-actions-bot-user/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
<!-- start title -->

# GitHub Action: Get GitHub Actions bot user
# <img src=".github/ghadocs/branding.svg" width="60px" align="center" alt="branding<icon:user-check color:gray-dark>" /> GitHub Action: Get GitHub Actions bot user

<!-- end title -->
<!--
// jscpd:ignore-start
-->
<!-- start badges -->

<a href="https%3A%2F%2Fgithub.com%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%2Fgithub.com%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%2Fgithub.com%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" />
<a href="https%3A%2F%2Fgithub.com%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%2Fgithub.com%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%2Fgithub.com%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 -->
<!--
Expand All @@ -28,7 +24,7 @@ Action to get the GitHub Actions bot user informations. Usefull to commit, comme
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/[email protected].2
- uses: hoverkraft-tech/[email protected].3
with:
```
Expand Down
10 changes: 3 additions & 7 deletions actions/get-issue-number/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
<!-- start title -->

# GitHub Action: Get issue number
# <img src=".github/ghadocs/branding.svg" width="60px" align="center" alt="branding<icon:hash color:gray-dark>" /> GitHub Action: Get issue number

<!-- end title -->
<!--
// jscpd:ignore-start
-->
<!-- start badges -->

<a href="https%3A%2F%2Fgithub.com%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%2Fgithub.com%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%2Fgithub.com%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" />
<a href="https%3A%2F%2Fgithub.com%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%2Fgithub.com%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%2Fgithub.com%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 -->
<!--
Expand All @@ -28,7 +24,7 @@ Action to get Pull request or issue number
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/[email protected].2
- uses: hoverkraft-tech/[email protected].3
with:
```
Expand Down
Loading

0 comments on commit 7bdd1d6

Please sign in to comment.