Skip to content

docs(hoverkraft-tech/ci-github-common): update documentation #882

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.

Sign up for GitHub

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

Merged
hoverkraft-bot merged 1 commit into from
Apr 15, 2026
Merged

docs(hoverkraft-tech/ci-github-common): update documentation #882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions ...projects/github-actions-and-reusable-workflows/ci-github-common/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
source_repo: hoverkraft-tech/ci-github-common
source_path: CONTRIBUTING.md
source_branch: main
source_run_id: 24344561437
last_synced: 2026-04-13T13:01:24.956Z
source_branch: 0.34.2
source_run_id: 24441949898
last_synced: 2026-04-15T07:32:42.397Z
---

# Contributing
Expand Down
1 change: 1 addition & 0 deletions ...ojects/github-actions-and-reusable-workflows/ci-github-common/actions/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ sidebar_label: Actions
---

This page is generated automatically to introduce the Actions documentation section.

28 changes: 14 additions & 14 deletions ...ithub-actions-and-reusable-workflows/ci-github-common/actions/checkout/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Checkout
source_repo: hoverkraft-tech/ci-github-common
source_path: actions/checkout/README.md
source_branch: main
source_run_id: 24344561437
last_synced: 2026-04-13T13:01:24.956Z
source_branch: 0.34.2
source_run_id: 24441949898
last_synced: 2026-04-15T07:32:42.397Z
---

<!-- header:start -->
Expand Down Expand Up @@ -52,7 +52,7 @@ permissions:
## Usage

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/checkout@4b53189212d5810f710bed89711002626977215b # 0.33.0
- uses: hoverkraft-tech/ci-github-common/actions/checkout@71b85947453f32b5d147ff3ab37351439a92d840 # 0.34.2
with:
# Number of commits to fetch. 0 indicates all history for all branches and tags.
# See https://github.com/actions/checkout#usage
Expand Down Expand Up @@ -83,16 +83,16 @@ permissions:

## Inputs

| **Input** | **Description** | **Required** | **Default** |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------- | ------------ | ----------- |
| **`fetch-depth`** | Number of commits to fetch. 0 indicates all history for all branches and tags. | **false** | `1` |
| | See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | |
| **`lfs`** | Whether to download Git-LFS files. | **false** | `false` |
| | See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | |
| **`persist-credentials`** | Whether to persist the token credentials in the Git config. | **false** | `false` |
| | Default to false for security reasons. | | |
| | See [https://github.com/orgs/community/discussions/179107](https://github.com/orgs/community/discussions/179107). | | |
| **`token`** | Token to use for checking out the repository instead of the default GITHUB_TOKEN. | **false** | - |
| **Input** | **Description** | **Required** | **Default** |
| ------------------------- | --------------------------------------------------------------------------------- | ------------ | ----------- |
| **`fetch-depth`** | Number of commits to fetch. 0 indicates all history for all branches and tags. | **false** | `1` |
| | See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | |
| **`lfs`** | Whether to download Git-LFS files. | **false** | `false` |
| | See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | |
| **`persist-credentials`** | Whether to persist the token credentials in the Git config. | **false** | `false` |
| | Default to false for security reasons. | | |
| | See [https://github.com/orgs/community/discussions/179107](https://github.com/orgs/community/discussions/179107). | | |
| **`token`** | Token to use for checking out the repository instead of the default GITHUB_TOKEN. | **false** | - |

<!-- inputs:end -->

Expand Down
24 changes: 12 additions & 12 deletions ...sable-workflows/ci-github-common/actions/create-and-merge-pull-request/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Create And Merge Pull Request
source_repo: hoverkraft-tech/ci-github-common
source_path: actions/create-and-merge-pull-request/README.md
source_branch: main
source_run_id: 24344561437
last_synced: 2026-04-13T13:01:24.956Z
source_branch: 0.34.2
source_run_id: 24441949898
last_synced: 2026-04-15T07:32:42.397Z
---

<!-- header:start -->
Expand Down Expand Up @@ -46,7 +46,7 @@ See [https://docs.github.com/en/repositories/managing-your-repositorys-settings-
## Usage

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@4b53189212d5810f710bed89711002626977215b # 0.33.0
- uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@71b85947453f32b5d147ff3ab37351439a92d840 # 0.34.2
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.
Expand Down Expand Up @@ -77,14 +77,14 @@ See [https://docs.github.com/en/repositories/managing-your-repositorys-settings-

## Inputs

| **Input** | **Description** | **Required** | **Default** |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
| **`github-token`** | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write). | **false** | `${{ github.token }}` |
| | See [https://github.com/peter-evans/create-pull-request#action-inputs](https://github.com/peter-evans/create-pull-request#action-inputs). | | |
| **`branch`** | The pull request branch name | **true** | - |
| **`title`** | The pull request title | **true** | - |
| **`body`** | The pull request body | **true** | - |
| **`commit-message`** | The commit message for the pull request | **true** | - |
| **Input** | **Description** | **Required** | **Default** |
| -------------------- | ---------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
| **`github-token`** | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write). | **false** | `${{ github.token }}` |
| | See [https://github.com/peter-evans/create-pull-request#action-inputs](https://github.com/peter-evans/create-pull-request#action-inputs). | | |
| **`branch`** | The pull request branch name | **true** | - |
| **`title`** | The pull request title | **true** | - |
| **`body`** | The pull request body | **true** | - |
| **`commit-message`** | The commit message for the pull request | **true** | - |

<!-- inputs:end -->

Expand Down
30 changes: 15 additions & 15 deletions ...d-reusable-workflows/ci-github-common/actions/create-or-update-comment/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Create Or Update Comment
source_repo: hoverkraft-tech/ci-github-common
source_path: actions/create-or-update-comment/README.md
source_branch: main
source_run_id: 24344561437
last_synced: 2026-04-13T13:01:24.956Z
source_branch: 0.34.2
source_run_id: 24441949898
last_synced: 2026-04-15T07:32:42.397Z
---

<!-- header:start -->
Expand Down Expand Up @@ -50,7 +50,7 @@ permissions:
## Usage

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/create-or-update-comment@4b53189212d5810f710bed89711002626977215b # 0.33.0
- uses: hoverkraft-tech/ci-github-common/actions/create-or-update-comment@71b85947453f32b5d147ff3ab37351439a92d840 # 0.34.2
with:
# The comment title.
# Must be static and unique, will be used to retrieve the comment if exists already.
Expand Down Expand Up @@ -81,17 +81,17 @@ permissions:

## Inputs

| **Input** | **Description** | **Required** | **Default** |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
| **`title`** | The comment title. | **true** | - |
| | Must be static and unique, will be used to retrieve the comment if exists already. | | |
| **`body`** | The comment body. | **false** | - |
| | See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment). | | |
| **`reactions`** | A comma separated list of reactions to add to the comment. | **false** | - |
| | See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment). | | |
| **`comment-author`** | The comment author. | **false** | `github-actions[bot]` |
| **`token`** | Optional token to interact with GitHub API. | **false** | - |
| | If not defined or empty, the action will use the GITHUB_TOKEN provided by GitHub. | | |
| **Input** | **Description** | **Required** | **Default** |
| -------------------- | ---------------------------------------------------------------------------------- | ------------ | --------------------- |
| **`title`** | The comment title. | **true** | - |
| | Must be static and unique, will be used to retrieve the comment if exists already. | | |
| **`body`** | The comment body. | **false** | - |
| | See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment). | | |
| **`reactions`** | A comma separated list of reactions to add to the comment. | **false** | - |
| | See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment). | | |
| **`comment-author`** | The comment author. | **false** | `github-actions[bot]` |
| **`token`** | Optional token to interact with GitHub API. | **false** | - |
| | If not defined or empty, the action will use the GITHUB_TOKEN provided by GitHub. | | |

<!-- inputs:end -->

Expand Down
8 changes: 4 additions & 4 deletions ...eusable-workflows/ci-github-common/actions/get-github-actions-bot-user/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Get Github Actions Bot User
source_repo: hoverkraft-tech/ci-github-common
source_path: actions/get-github-actions-bot-user/README.md
source_branch: main
source_run_id: 24344561437
last_synced: 2026-04-13T13:01:24.956Z
source_branch: 0.34.2
source_run_id: 24441949898
last_synced: 2026-04-15T07:32:42.397Z
---

<!-- header:start -->
Expand Down Expand Up @@ -43,7 +43,7 @@ Useful to commit, comment, etc.
## Usage

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/get-github-actions-bot-user@4b53189212d5810f710bed89711002626977215b # 0.33.0
- uses: hoverkraft-tech/ci-github-common/actions/get-github-actions-bot-user@71b85947453f32b5d147ff3ab37351439a92d840 # 0.34.2
```

<!-- usage:end -->
Expand Down
8 changes: 4 additions & 4 deletions ...tions-and-reusable-workflows/ci-github-common/actions/get-issue-number/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Get Issue Number
source_repo: hoverkraft-tech/ci-github-common
source_path: actions/get-issue-number/README.md
source_branch: main
source_run_id: 24344561437
last_synced: 2026-04-13T13:01:24.956Z
source_branch: 0.34.2
source_run_id: 24441949898
last_synced: 2026-04-15T07:32:42.397Z
---

<!-- header:start -->
Expand Down Expand Up @@ -42,7 +42,7 @@ Action to get Pull request or issue number
## Usage

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/get-issue-number@4b53189212d5810f710bed89711002626977215b # 0.33.0
- uses: hoverkraft-tech/ci-github-common/actions/get-issue-number@71b85947453f32b5d147ff3ab37351439a92d840 # 0.34.2
```

<!-- usage:end -->
Expand Down
8 changes: 4 additions & 4 deletions ...ons-and-reusable-workflows/ci-github-common/actions/get-matrix-outputs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Get Matrix Outputs
source_repo: hoverkraft-tech/ci-github-common
source_path: actions/get-matrix-outputs/README.md
source_branch: main
source_run_id: 24344561437
last_synced: 2026-04-13T13:01:24.956Z
source_branch: 0.34.2
source_run_id: 24441949898
last_synced: 2026-04-15T07:32:42.397Z
---

<!-- header:start -->
Expand Down Expand Up @@ -43,7 +43,7 @@ Workaround for [https://github.com/orgs/community/discussions/26639](https://git
## Usage

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/get-matrix-outputs@4b53189212d5810f710bed89711002626977215b # 0.33.0
- uses: hoverkraft-tech/ci-github-common/actions/get-matrix-outputs@71b85947453f32b5d147ff3ab37351439a92d840 # 0.34.2
with:
# The name of the artifact to download.
# This input is required.
Expand Down
8 changes: 4 additions & 4 deletions ...-actions-and-reusable-workflows/ci-github-common/actions/local-actions/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Local Actions
source_repo: hoverkraft-tech/ci-github-common
source_path: actions/local-actions/README.md
source_branch: main
source_run_id: 24344561437
last_synced: 2026-04-13T13:01:24.956Z
source_branch: 0.34.2
source_run_id: 24441949898
last_synced: 2026-04-15T07:32:42.397Z
---

<!-- header:start -->
Expand Down Expand Up @@ -41,7 +41,7 @@ during the main step and removes it automatically in the post step.
## Usage

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/local-actions@03a5a2a3626b03434b19b79cdd2e141bea410bae # 0.34.1
- uses: hoverkraft-tech/ci-github-common/actions/local-actions@71b85947453f32b5d147ff3ab37351439a92d840 # 0.34.2
with:
# The actions root path that contains the sibling local actions.
# Pass the caller actions root, typically by appending `/../..` to `github.action_path`.
Expand Down
8 changes: 4 additions & 4 deletions ...and-reusable-workflows/ci-github-common/actions/local-workflow-actions/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Local Workflow Actions
source_repo: hoverkraft-tech/ci-github-common
source_path: actions/local-workflow-actions/README.md
source_branch: main
source_run_id: 24344561437
last_synced: 2026-04-13T13:01:24.956Z
source_branch: 0.34.2
source_run_id: 24441949898
last_synced: 2026-04-15T07:32:42.397Z
---

<!-- header:start -->
Expand Down Expand Up @@ -50,7 +50,7 @@ Example: if `local-path` is `./self-workflow` and `actions-path` is `.github/act
## Usage

```yaml
- uses: hoverkraft-tech/ci-github-common/actions/local-workflow-actions@4b53189212d5810f710bed89711002626977215b # 0.33.0
- uses: hoverkraft-tech/ci-github-common/actions/local-workflow-actions@71b85947453f32b5d147ff3ab37351439a92d840 # 0.34.2
with:
# Relative path(s) (inside the workflow repository) containing the local actions to expose in the current workspace.
# The same relative path will be used inside the current workspace (for example `.github/actions`).
Expand Down
Loading
Loading