Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update actions and workflows documentation #97

Merged
merged 1 commit into from
Jun 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.5.0
uses: hoverkraft-tech/ci-github-common/.github/workflows/generate-dependabot-config.yml@0.6.0
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.5.0
uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@0.6.0
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.5.0
uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@0.6.0
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.5.0
uses: hoverkraft-tech/ci-github-common/.github/workflows/release-actions.yml@0.6.0
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.5.0
uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@0.6.0
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.5.0
uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@0.6.0

# 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.5.0
- uses: hoverkraft-tech/ci-github-common/actions/checkout@v0.6.0
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.5.0
- uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@v0.6.0
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 @@ -22,7 +22,7 @@ permissions:
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/create-or-update-comment@v0.5.0
- uses: hoverkraft-tech/ci-github-common/actions/create-or-update-comment@v0.6.0
with:
# The comment title. Must be static and unique, will be used to retrieve the
# comment if exists already.
Expand Down
2 changes: 1 addition & 1 deletion 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.5.0
- uses: hoverkraft-tech/ci-github-common/actions/get-github-actions-bot-user@v0.6.0
with:
```

Expand Down
2 changes: 1 addition & 1 deletion 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.5.0
- uses: hoverkraft-tech/ci-github-common/actions/get-issue-number@v0.6.0
with:
```

Expand Down
4 changes: 2 additions & 2 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.5.0
- uses: hoverkraft-tech/ci-github-common/actions/get-matrix-outputs@v0.6.0
with:
# The name of the artifact to download.
artifact-name: ""
Expand All @@ -29,7 +29,7 @@ Download matrix ouputs from artifacts, because GitHub action does not handle job
<!-- end inputs -->
<!-- start outputs -->

| **Output** | **Description** | **Default** | **Required** |
| \***\*Output\*\*** | \***\*Description\*\*** | \***\*Default\*\*** | \***\*Required\*\*** |
| ------------------- | --------------------------------- | ------------------- | -------------------- |
| <code>result</code> | The matrix combined JSON outputs. | undefined | undefined |

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.5.0
- uses: hoverkraft-tech/ci-github-common/actions/set-matrix-output@v0.6.0
with:
# The matrix output to set.
value: ""
Expand Down
2 changes: 1 addition & 1 deletion 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.5.0
- uses: hoverkraft-tech/ci-github-common/actions/slugify@v0.6.0
with:
# The value to slugify
value: ""
Expand Down