Skip to content

Commit 5ac7816

Browse files
hoverkraft-bot[bot]hoverkraft-bot[bot]
authored
docs(hoverkraft-tech/ci-github-common): update documentation
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 32133c2 commit 5ac7816

22 files changed

Lines changed: 200 additions & 176 deletions

File tree

‎application/docs/projects/ci-github-common/CONTRIBUTING.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
source_repo: hoverkraft-tech/ci-github-common
33
source_path: CONTRIBUTING.md
4-
source_branch: 0.30.1
5-
source_run_id: 19577732482
6-
last_synced: 2025-11-21T17:06:32.090Z
4+
source_branch: main
5+
source_run_id: 19607823380
6+
last_synced: 2025-11-23T07:32:13.139Z
77
---
88

99
# Contributing

‎application/docs/projects/ci-github-common/_index.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: Ci Github Common
33
description: Documentation for Ci Github Common
44
---
55

6-
Documentation for the Ci GitHub Common project.
6+
# Ci Github Common
7+
8+
Documentation for the Ci Github Common project.
79

810
**Source Repository:** [hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common)
9-
**Last Synced:** 2025-11-21T17:06:32.090Z
11+
**Last Synced:** 2025-11-23T07:32:13.139Z

‎application/docs/projects/ci-github-common/actions/_index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ sidebar_label: Actions
55
---
66

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

‎application/docs/projects/ci-github-common/actions/checkout/index.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Checkout
33
source_repo: hoverkraft-tech/ci-github-common
44
source_path: actions/checkout/README.md
5-
source_branch: 0.30.1
6-
source_run_id: 19577732482
7-
last_synced: 2025-11-21T17:06:32.090Z
5+
source_branch: main
6+
source_run_id: 19607823380
7+
last_synced: 2025-11-23T07:32:13.139Z
88
---
99

1010
<!-- header:start -->
@@ -77,14 +77,14 @@ permissions:
7777
7878
## Inputs
7979
80-
| **Input** | **Description** | **Required** | **Default** |
81-
| ----------------- | ------------------------------------------------------------------------------------------ | ------------ | ----------- |
82-
| **`fetch-depth`** | Number of commits to fetch. 0 indicates all history for all branches and tags. | **false** | `1` |
83-
| | See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | |
84-
| **`lfs`** | Whether to download Git-LFS files. | **false** | `false` |
85-
| | See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | |
86-
| **`token`** | Token to use for checking out the repository instead of the default GITHUB_TOKEN. | **false** | - |
87-
| | If specified and not empty, persist-credentials in checkout will be false. | | |
80+
| **Input** | **Description** | **Required** | **Default** |
81+
| ----------------- | --------------------------------------------------------------------------------- | ------------ | ----------- |
82+
| **`fetch-depth`** | Number of commits to fetch. 0 indicates all history for all branches and tags. | **false** | `1` |
83+
| | See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | |
84+
| **`lfs`** | Whether to download Git-LFS files. | **false** | `false` |
85+
| | See [https://github.com/actions/checkout#usage](https://github.com/actions/checkout#usage) | | |
86+
| **`token`** | Token to use for checking out the repository instead of the default GITHUB_TOKEN. | **false** | - |
87+
| | If specified and not empty, persist-credentials in checkout will be false. | | |
8888

8989
<!-- inputs:end -->
9090

‎application/docs/projects/ci-github-common/actions/create-and-merge-pull-request/index.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Create And Merge Pull Request
33
source_repo: hoverkraft-tech/ci-github-common
44
source_path: actions/create-and-merge-pull-request/README.md
5-
source_branch: 0.30.1
6-
source_run_id: 19577732482
7-
last_synced: 2025-11-21T17:06:32.090Z
5+
source_branch: main
6+
source_run_id: 19607823380
7+
last_synced: 2025-11-23T07:32:13.139Z
88
---
99

1010
<!-- header:start -->
@@ -77,14 +77,14 @@ See [https://docs.github.com/en/repositories/managing-your-repositorys-settings-
7777
7878
## Inputs
7979
80-
| **Input** | **Description** | **Required** | **Default** |
81-
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------------------- |
82-
| **`github-token`** | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write). | **false** | `$\{\{ github.token }}` |
83-
| | See [https://github.com/peter-evans/create-pull-request#action-inputs](https://github.com/peter-evans/create-pull-request#action-inputs). | | |
84-
| **`branch`** | The pull request branch name | **true** | - |
85-
| **`title`** | The pull request title | **true** | - |
86-
| **`body`** | The pull request body | **true** | - |
87-
| **`commit-message`** | The commit message for the pull request | **true** | - |
80+
| **Input** | **Description** | **Required** | **Default** |
81+
| -------------------- | ---------------------------------------------------------------------------------------------------------- | ------------ | ----------------------- |
82+
| **`github-token`** | GitHub token for creating and merging pull request (permissions contents: write and pull-requests: write). | **false** | `$\{\{ github.token }}` |
83+
| | See [https://github.com/peter-evans/create-pull-request#action-inputs](https://github.com/peter-evans/create-pull-request#action-inputs). | | |
84+
| **`branch`** | The pull request branch name | **true** | - |
85+
| **`title`** | The pull request title | **true** | - |
86+
| **`body`** | The pull request body | **true** | - |
87+
| **`commit-message`** | The commit message for the pull request | **true** | - |
8888

8989
<!-- inputs:end -->
9090

‎application/docs/projects/ci-github-common/actions/create-or-update-comment/index.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Create Or Update Comment
33
source_repo: hoverkraft-tech/ci-github-common
44
source_path: actions/create-or-update-comment/README.md
5-
source_branch: 0.30.1
6-
source_run_id: 19577732482
7-
last_synced: 2025-11-21T17:06:32.090Z
5+
source_branch: main
6+
source_run_id: 19607823380
7+
last_synced: 2025-11-23T07:32:13.139Z
88
---
99

1010
<!-- header:start -->
@@ -81,17 +81,17 @@ permissions:
8181
8282
## Inputs
8383
84-
| **Input** | **Description** | **Required** | **Default** |
85-
| -------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
86-
| **`title`** | The comment title. | **true** | - |
87-
| | Must be static and unique, will be used to retrieve the comment if exists already. | | |
88-
| **`body`** | The comment body. | **false** | - |
89-
| | See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment). | | |
90-
| **`reactions`** | A comma separated list of reactions to add to the comment. | **false** | - |
91-
| | See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment). | | |
92-
| **`comment-author`** | The comment author. | **false** | `github-actions[bot]` |
93-
| **`token`** | Optional token to interact with GitHub API. | **false** | - |
94-
| | If not defined or empty, the action will use the GITHUB_TOKEN provided by GitHub. | | |
84+
| **Input** | **Description** | **Required** | **Default** |
85+
| -------------------- | ---------------------------------------------------------------------------------- | ------------ | --------------------- |
86+
| **`title`** | The comment title. | **true** | - |
87+
| | Must be static and unique, will be used to retrieve the comment if exists already. | | |
88+
| **`body`** | The comment body. | **false** | - |
89+
| | See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment). | | |
90+
| **`reactions`** | A comma separated list of reactions to add to the comment. | **false** | - |
91+
| | See [https://github.com/peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment). | | |
92+
| **`comment-author`** | The comment author. | **false** | `github-actions[bot]` |
93+
| **`token`** | Optional token to interact with GitHub API. | **false** | - |
94+
| | If not defined or empty, the action will use the GITHUB_TOKEN provided by GitHub. | | |
9595

9696
<!-- inputs:end -->
9797

‎application/docs/projects/ci-github-common/actions/get-github-actions-bot-user/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Get Github Actions Bot User
33
source_repo: hoverkraft-tech/ci-github-common
44
source_path: actions/get-github-actions-bot-user/README.md
5-
source_branch: 0.30.1
6-
source_run_id: 19577732482
7-
last_synced: 2025-11-21T17:06:32.090Z
5+
source_branch: main
6+
source_run_id: 19607823380
7+
last_synced: 2025-11-23T07:32:13.139Z
88
---
99

1010
<!-- header:start -->

‎application/docs/projects/ci-github-common/actions/get-issue-number/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Get Issue Number
33
source_repo: hoverkraft-tech/ci-github-common
44
source_path: actions/get-issue-number/README.md
5-
source_branch: 0.30.1
6-
source_run_id: 19577732482
7-
last_synced: 2025-11-21T17:06:32.090Z
5+
source_branch: main
6+
source_run_id: 19607823380
7+
last_synced: 2025-11-23T07:32:13.139Z
88
---
99

1010
<!-- header:start -->

‎application/docs/projects/ci-github-common/actions/get-matrix-outputs/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Get Matrix Outputs
33
source_repo: hoverkraft-tech/ci-github-common
44
source_path: actions/get-matrix-outputs/README.md
5-
source_branch: 0.30.1
6-
source_run_id: 19577732482
7-
last_synced: 2025-11-21T17:06:32.090Z
5+
source_branch: main
6+
source_run_id: 19607823380
7+
last_synced: 2025-11-23T07:32:13.139Z
88
---
99

1010
<!-- header:start -->

‎application/docs/projects/ci-github-common/actions/parse-ci-reports/index.md‎

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Parse Ci Reports
33
source_repo: hoverkraft-tech/ci-github-common
44
source_path: actions/parse-ci-reports/README.md
5-
source_branch: 0.30.1
6-
source_run_id: 19577732482
7-
last_synced: 2025-11-21T17:06:32.090Z
5+
source_branch: main
6+
source_run_id: 19607823380
7+
last_synced: 2025-11-23T07:32:13.139Z
88
---
99

1010
<!-- header:start -->
@@ -58,6 +58,7 @@ It supports multiple common report standards out of the box.
5858

5959
- **ESLint JSON** - JavaScript/TypeScript linting
6060
- **CheckStyle XML** - Java and other language linting
61+
- **Prettier Check Logs** - Text output captured from `prettier --check`
6162

6263
<!-- usage:start -->
6364

@@ -217,6 +218,24 @@ Auto-detection modes:
217218
output-format: "summary"
218219
```
219220

221+
### Prettier Formatting Check
222+
223+
Capture the output of `prettier --check` and feed it to the parser to surface
224+
formatting issues alongside other lint results:
225+
226+
```yaml
227+
- name: Run Prettier check
228+
run: |
229+
npx prettier --check "src/**/*.{js,ts,tsx}" | tee prettier-check.log
230+
231+
- name: Parse Prettier report
232+
uses: hoverkraft-tech/ci-github-common/actions/parse-ci-reports@c314229c3ca6914f7023ffca7afc26753ab99b41 # 0.30.1
233+
with:
234+
report-paths: "prettier-check.log"
235+
report-name: "Prettier Formatting"
236+
output-format: "summary"
237+
```
238+
220239
### Fail on Test Failures
221240

222241
```yaml

0 commit comments

Comments
 (0)