Skip to content

Commit 3865547

Browse files
shenxianpeng2bndy5
authored andcommitted
add step-summary screenshot and update introduction #151 (#153)
* add step-summary screenshot and update introduction #151 * Update action.yml Co-authored-by: Brendan <2bndy5@gmail.com> * Update README.md Co-authored-by: Brendan <2bndy5@gmail.com> --------- Co-authored-by: Brendan <2bndy5@gmail.com>
1 parent 5aa2227 commit 3865547

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![MkDocs Deploy](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml)
99
![GitHub](https://img.shields.io/github/license/cpp-linter/cpp-linter-action?label=license&logo=github)
1010

11-
A Github Action for linting C/C++ code integrating clang-tidy and clang-format to collect feedback provided in the form of thread comments and/or annotations.
11+
A Github Action for linting C/C++ code integrating clang-tidy and clang-format to collect feedback provided in the form of annotations, thread comments, and step summary.
1212

1313
## What's New
1414

@@ -171,6 +171,10 @@ This action creates 1 output variable named `checks-failed`. Even if the linting
171171

172172
![sample comment](https://raw.githubusercontent.com/cpp-linter/cpp-linter-action/main/docs/images/comment.png)
173173

174+
### Step Summary
175+
176+
![step summary](https://raw.githubusercontent.com/cpp-linter/cpp-linter-action/main/docs/images/step-summary.png)
177+
174178
<!--footer-start-->
175179

176180
## Add C/C++ Linter Action badge in README

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: C/C++ Linter
2-
description: Lint C/C++ code with clang-format and clang-tidy then post annotations and comments with faulty results.
2+
description: Lint C/C++ code with clang-format and clang-tidy then post annotations, comments, and step summary with results.
33
author: shenxianpeng
44
branding:
55
icon: "check-circle"

docs/images/step-summary.png

51.1 KB
Loading

0 commit comments

Comments
 (0)