-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update actions and workflows documentation
[skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
- Loading branch information
1 parent
993bf11
commit 02b0389
Showing
16 changed files
with
28 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,7 +30,7 @@ permissions: | |
|
|
||
| jobs: | ||
| main: | ||
| uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].1 | ||
| uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].2 | ||
| with: | ||
| # GitHub App ID to generate GitHub token in place of github-token. | ||
| # See https://github.com/actions/create-github-app-token | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,7 +36,7 @@ permissions: | |
|
|
||
| jobs: | ||
| greetings: | ||
| uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].1 | ||
| uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].2 | ||
| secrets: | ||
| # Token for the repository. | ||
| # See https://github.com/actions/first-interaction#usage | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,7 +34,7 @@ permissions: | |
|
|
||
| jobs: | ||
| main: | ||
| uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].1 | ||
| uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].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 | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -40,7 +40,7 @@ permissions: | |
|
|
||
| jobs: | ||
| main: | ||
| uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].1 | ||
| uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].2 | ||
| with: | ||
| manual-commit-ref: ${{ inputs.manual-commit-ref }} | ||
| manual-base-ref: ${{ inputs.manual-base-ref }} | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -41,7 +41,7 @@ concurrency: | |
|
|
||
| jobs: | ||
| release: | ||
| uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].1 | ||
| uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].2 | ||
| with: | ||
| # Update all actions and workflows, regardless of changes. | ||
| update-all: false | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,7 +36,7 @@ permissions: | |
|
|
||
| jobs: | ||
| main: | ||
| uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].1 | ||
| uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].2 | ||
| secrets: | ||
| # Token for the repository. | ||
| # Default GITHUB_TOKEN | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,7 +30,7 @@ permissions: | |
|
|
||
| jobs: | ||
| main: | ||
| uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].1 | ||
| uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected].2 | ||
|
|
||
| # Optional customizations. | ||
| with: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,7 +33,7 @@ permissions: | |
| <!-- start usage --> | ||
| ```yaml | ||
| - uses: hoverkraft-tech/[email protected].1 | ||
| - uses: hoverkraft-tech/[email protected].2 | ||
| with: | ||
| # Description: Number of commits to fetch. 0 indicates all history for all | ||
| # branches and tags. See | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,9 @@ | |
|
|
||
| <!-- end branding --> | ||
| <!-- 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" /> | ||
|
|
||
| <!-- end badges --> | ||
| <!-- start description --> | ||
|
|
||
|
|
@@ -27,11 +30,11 @@ Allow GitHub Actions to create and approve pull requests](https://docs.github.co | |
| <!-- start usage --> | ||
|
|
||
| ```yaml | ||
| - uses: hoverkraft-tech/[email protected].1 | ||
| - uses: hoverkraft-tech/[email protected].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 | |
| <!-- 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 --> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -32,7 +32,7 @@ permissions: | |
| <!-- start usage --> | ||
| ```yaml | ||
| - uses: hoverkraft-tech/[email protected].1 | ||
| - uses: hoverkraft-tech/[email protected].2 | ||
| with: | ||
| # Description: The comment title. Must be static and unique, will be used to | ||
| # retrieve the comment if exists already. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,7 +23,7 @@ Action to get the GitHub Actions bot user informations. Usefull to commit, comme | |
| <!-- start usage --> | ||
|
|
||
| ```yaml | ||
| - uses: hoverkraft-tech/[email protected].1 | ||
| - uses: hoverkraft-tech/[email protected].2 | ||
| with: | ||
| ``` | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,7 +23,7 @@ Action to get Pull request or issue number | |
| <!-- start usage --> | ||
|
|
||
| ```yaml | ||
| - uses: hoverkraft-tech/[email protected].1 | ||
| - uses: hoverkraft-tech/[email protected].2 | ||
| with: | ||
| ``` | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,7 +23,7 @@ Download matrix ouputs from artifacts, because GitHub action does not handle job | |
| <!-- start usage --> | ||
|
|
||
| ```yaml | ||
| - uses: hoverkraft-tech/[email protected].1 | ||
| - uses: hoverkraft-tech/[email protected].2 | ||
| with: | ||
| # Description: The name of the artifact to download. | ||
| # | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,7 +23,7 @@ Action to check if the repository owner is an organization. | |
| <!-- start usage --> | ||
|
|
||
| ```yaml | ||
| - uses: hoverkraft-tech/[email protected].1 | ||
| - uses: hoverkraft-tech/[email protected].2 | ||
| with: | ||
| # Description: GitHub token for fetching users API. | ||
| # | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,7 +28,7 @@ This strategy effectively prevents any clashes or overwrites, maintaining the in | |
| <!-- start usage --> | ||
|
|
||
| ```yaml | ||
| - uses: hoverkraft-tech/[email protected].1 | ||
| - uses: hoverkraft-tech/[email protected].2 | ||
| with: | ||
| # Description: The matrix output to set. | ||
| # | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,7 +23,7 @@ Action to slugify a given string value | |
| <!-- start usage --> | ||
|
|
||
| ```yaml | ||
| - uses: hoverkraft-tech/[email protected].1 | ||
| - uses: hoverkraft-tech/[email protected].2 | ||
| with: | ||
| # Description: The value to slugify | ||
| # | ||
|
|
||