Skip to content

Commit 5aa2227

Browse files
authored
solution for #151 (#152)
1 parent 1045e02 commit 5aa2227

File tree

3 files changed

+21
-2
lines changed

3 files changed

+21
-2
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,12 +124,20 @@ jobs:
124124

125125
#### `thread-comments`
126126

127-
- **Description**: Set this option to false to disable the use of thread comments as feedback.
127+
- **Description**: Set this option to true to enable the use of thread comments as feedback.
128128
- To use thread comments, the `GITHUB_TOKEN` (provided by Github to each repository) must be declared as an environment
129129
variable. See [Authenticating with the GITHUB_TOKEN](https://docs.github.com/en/actions/reference/authentication-in-a-workflow)
130130
- Default: false
131131
- NOTE: If run on a private repository, then this feature is disabled because the GitHub REST API behaves differently for thread comments on a private repository.
132132

133+
#### `step-summary`
134+
135+
- **Description**: Set this option to true to append content as part of workflow's job summary.
136+
- See implementation details in GitHub's documentation about
137+
[Adding a job summary](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary).
138+
This option is independent of the `thread-comments` option, rather this option uses the same content that the `thread-comments` option would use.
139+
- Default: false
140+
133141
#### `file-annotations`
134142

135143
- **Description**: Set this option to false to disable the use of file annotations as feedback.

action.yml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,17 @@ branding:
66
color: "green"
77
inputs:
88
thread-comments:
9-
description: Set this option to false to disable the use of thread comments as feedback. Defaults to false.
9+
description: Set this option to true to enable the use of thread comments as feedback. Defaults to false.
10+
required: false
11+
default: false
12+
step-summary:
13+
description: >
14+
Set this option to true to append content as part of workflow's job summary. Defaults to false.
15+
16+
See implementation details in GitHub's documentation about
17+
[Adding a job summary](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary).
18+
This option is independent of the `thread-comments` option, rather this option uses the same content that
19+
the `thread-comments` option would use.
1020
required: false
1121
default: false
1222
file-annotations:
@@ -124,6 +134,7 @@ runs:
124134
--lines-changed-only=${{ inputs.lines-changed-only }} \
125135
--files-changed-only=${{ inputs.files-changed-only }} \
126136
--thread-comments=${{ inputs.thread-comments }} \
137+
--step-summary=${{ inputs.step-summary }} \
127138
--ignore="${{ inputs.ignore }}" \
128139
--database=${{ inputs.database }} \
129140
--file-annotations=${{ inputs.file-annotations }} \

docs/images/comment.png

-26.3 KB
Loading

0 commit comments

Comments
 (0)