Skip to content

Update docs and images #57

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.

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
merged 2 commits into from
Apr 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ jobs:

#### `version`

- **Description**: The desired version of the [clang-tools](https://hub.docker.com/repository/docker/xianpengshen/clang-tools) to use. Accepted options are strings which can be 14, 13, 12, 11, 10, 9, or 8.
- **Description**: The desired version of the [clang-tools](https://hub.docker.com/r/xianpengshen/clang-tools) to use. Accepted options are strings which can be 14, 13, 12, 11, 10, 9, or 8.
- Default: '10'

#### `verbosity`
Expand Down Expand Up @@ -183,13 +183,15 @@ All input options listed above are specified by pre-pending a `--`. You can also

<!--intro-end-->

### Thread Comment
### Annotations

![github-actions bot](./docs/images/demo_comment.png)
<a href="url"><img src="./docs/images/annotations-clang-format.png" height="408" width="744" ></a>

### Annotations
<a href="url"><img src="./docs/images/annotations-clang-tidy.png" height="446" width="547" ></a>

### Thread Comment

![workflow annotations](./docs/images/demo_annotations.png)
<a href="url"><img src="./docs/images/comment.png" height="975" width="831" ></a>

<!--footer-start-->

Expand Down
Binary file added docs/images/annotations-clang-format.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/annotations-clang-tidy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/comment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/demo_annotations.png
Binary file not shown.
Binary file removed docs/images/demo_comment.png
Binary file not shown.
Binary file removed docs/images/result.png
Binary file not shown.
10 changes: 6 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@
end="<!--intro-end-->"
%}

### Thread Comment
### Annotations

![sample comment](images/demo_comment.png)
![clang-format annotations](images/annotations-clang-format.png)

### Annotations
![clang-tidy annotations](images/annotations-clang-tidy.png)

### Thread Comment

![workflow annotations](images/demo_annotations.png)
![sample comment](images/comment.png)

{%
include-markdown "../README.md"
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"A python package that powers the github action named cpp-linter-action. "
+ f"See `the github repository README <{REPO}#readme>`_ for full details."
),
author="Brendan Doherty, Peter Shen",
author="Brendan Doherty",
author_email="[email protected]",
install_requires=["requests", "pyyaml"], # pyyaml is installed with clang-tidy
license="MIT",
Expand Down