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] authored and hoverkraft-bot[bot] committed Apr 5, 2023
1 parent 3d62948 commit a7336a8
Show file tree
Hide file tree
Showing 14 changed files with 27 additions and 27 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 @@ -22,7 +22,7 @@ on:
- main
jobs:
main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/generate-dependabot-config.yml@0.4.2
uses: hoverkraft-tech/ci-github-common/.github/workflows/generate-dependabot-config.yml@0.4.3
with:
# GitHub App ID to generate GitHub token in place of github-token.
# See https://github.com/tibdex/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 @@ -25,7 +25,7 @@ on:

jobs:
main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@0.4.2
uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@0.4.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 @@ -26,7 +26,7 @@ on:

jobs:
main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@0.4.2
uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@0.4.3
secrets:
# Token for marking the status of linter run in the Checks section.
# See https://github.com/github/super-linter#how-to-use
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 @@ -25,7 +25,7 @@ on:

jobs:
release:
uses: hoverkraft-tech/ci-github-common/.github/workflows/release-actions.yml@0.4.2
uses: hoverkraft-tech/ci-github-common/.github/workflows/release-actions.yml@0.4.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 @@ -26,7 +26,7 @@ on:

jobs:
main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@0.4.2
uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@0.4.3
secrets:
# Token for the repository.
# See https://github.com/amannn/action-semantic-pull-request#installation
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/stale.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ on:

jobs:
main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@0.4.2
uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@0.4.3

# Optional customizations.
with:
Expand Down
2 changes: 1 addition & 1 deletion actions/checkout/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ permissions:
<!-- start usage -->
```yaml
- uses: hoverkraft-tech/ci-github-common/actions/checkout@v0.4.2
- uses: hoverkraft-tech/ci-github-common/actions/checkout@v0.4.3
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)
Expand Down
2 changes: 1 addition & 1 deletion actions/create-and-merge-pull-request/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ 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.4.2
- uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@v0.4.3
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)
Expand Down
2 changes: 1 addition & 1 deletion actions/create-or-update-comment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Action to create or update comment in pull request or issue
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/create-or-update-comment@v0.4.2
- uses: hoverkraft-tech/ci-github-common/actions/create-or-update-comment@v0.4.3
with:
# The comment title. Must be static and unique, will be used to retrieve the
# comment if exists already.
Expand Down
10 changes: 5 additions & 5 deletions actions/get-github-actions-bot-user/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Action to get the GitHub Actions bot user informations. Usefull to commit, comme
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/get-github-actions-bot-user@v0.4.2
- uses: hoverkraft-tech/ci-github-common/actions/get-github-actions-bot-user@v0.4.3
with:
```
Expand All @@ -22,10 +22,10 @@ Action to get the GitHub Actions bot user informations. Usefull to commit, comme
<!-- end inputs -->
<!-- start outputs -->
| **Output** | **Description** | **Default** | **Required** |
| ------------------ | ---------------------------------- | ----------- | ------------ |
| <code>email</code> | The GitHub Actions bot user email. | undefined | undefined |
| <code>name</code> | The GitHub Actions bot username. | undefined | undefined |
| \***\*Output\*\*** | \***\*Description\*\*** | \***\*Default\*\*** | \***\*Required\*\*** |
| ------------------ | ---------------------------------- | ------------------- | -------------------- |
| <code>email</code> | The GitHub Actions bot user email. | undefined | undefined |
| <code>name</code> | The GitHub Actions bot username. | undefined | undefined |
<!-- end outputs -->
<!-- start [.github/ghadocs/examples/] -->
Expand Down
8 changes: 4 additions & 4 deletions actions/get-issue-number/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Action to get Pull request or issue number
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/get-issue-number@v0.4.2
- uses: hoverkraft-tech/ci-github-common/actions/get-issue-number@v0.4.3
with:
```
Expand All @@ -22,9 +22,9 @@ Action to get Pull request or issue number
<!-- end inputs -->
<!-- start outputs -->
| **Output** | **Description** | **Default** | **Required** |
| ------------------------- | ----------------- | ----------- | ------------ |
| <code>issue-number</code> | The issue number. | undefined | undefined |
| \***\*Output\*\*** | \***\*Description\*\*** | \***\*Default\*\*** | \***\*Required\*\*** |
| ------------------------- | ----------------------- | ------------------- | -------------------- |
| <code>issue-number</code> | The issue number. | undefined | undefined |
<!-- end outputs -->
<!-- start [.github/ghadocs/examples/] -->
Expand Down
8 changes: 4 additions & 4 deletions actions/get-matrix-outputs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Download matrix ouputs from artifacts, because GitHub action does not handle job
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/get-matrix-outputs@v0.4.2
- uses: hoverkraft-tech/ci-github-common/actions/get-matrix-outputs@v0.4.3
with:
# The name of the artifact to download.
artifact-name: ""
Expand All @@ -29,9 +29,9 @@ Download matrix ouputs from artifacts, because GitHub action does not handle job
<!-- end inputs -->
<!-- start outputs -->
| **Output** | **Description** | **Default** | **Required** |
| ------------------- | --------------------------------- | ----------- | ------------ |
| <code>result</code> | The matrix combined JSON outputs. | undefined | undefined |
| \***\*Output\*\*** | \***\*Description\*\*** | \***\*Default\*\*** | \***\*Required\*\*** |
| ------------------- | --------------------------------- | ------------------- | -------------------- |
| <code>result</code> | The matrix combined JSON outputs. | undefined | undefined |
<!-- end outputs -->
<!-- start [.github/ghadocs/examples/] -->
Expand Down
2 changes: 1 addition & 1 deletion actions/set-matrix-output/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Set matrix ouput in file to be uploaded as artifacts, because GitHub action does
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/set-matrix-output@v0.4.2
- uses: hoverkraft-tech/ci-github-common/actions/set-matrix-output@v0.4.3
with:
# The matrix output to set.
value: ""
Expand Down
8 changes: 4 additions & 4 deletions actions/slugify/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Action to slugify a given string value
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/slugify@v0.4.2
- uses: hoverkraft-tech/ci-github-common/actions/slugify@v0.4.3
with:
# The value to slugify
value: ""
Expand All @@ -29,9 +29,9 @@ Action to slugify a given string value
<!-- end inputs -->
<!-- start outputs -->
| **Output** | **Description** | **Default** | **Required** |
| ------------------- | ------------------- | ----------- | ------------ |
| <code>result</code> | The slugified value | undefined | undefined |
| \***\*Output\*\*** | \***\*Description\*\*** | \***\*Default\*\*** | \***\*Required\*\*** |
| ------------------- | ----------------------- | ------------------- | -------------------- |
| <code>result</code> | The slugified value | undefined | undefined |
<!-- end outputs -->
<!-- start [.github/ghadocs/examples/] -->
Expand Down

0 comments on commit a7336a8

Please sign in to comment.