Skip to content

Commit 0070d02

Browse files
committed
add what is new to README
1 parent f564202 commit 0070d02

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

+15-7
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,36 @@
1111

1212
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.
1313

14+
## What's New
15+
16+
v2
17+
18+
* Change action from using docker to composite steps
19+
* improve workflow runs times from 1m 24s (currently) to 6-20s.
20+
* better support for the database input option (which is currently broken with the docker env).
21+
* better support cross-compilation
22+
* better support 3rd party libraries
23+
* Includes many issues and enhancements. See [#87](https://github.com/cpp-linter/cpp-linter-action/issues/87) for details.
24+
25+
Refer [here](https://github.com/cpp-linter/cpp-linter-action/tree/v1) for previous versions.
26+
1427
## Usage
1528

1629
Create a new GitHub Actions workflow in your project, e.g. at [.github/workflows/cpp-linter.yml](https://github.com/cpp-linter/cpp-linter-action/blob/master/.github/workflows/cpp-linter.yml)
1730

1831
The content of the file should be in the following format.
1932

2033
```yaml
21-
# Workflow syntax:
22-
# https://help.github.com/en/articles/workflow-syntax-for-github-actions
2334
name: cpp-linter
2435

25-
on:
26-
pull_request:
27-
types: [opened, reopened] # let PR-synchronize events be handled by push events
28-
push:
36+
on: pull_request
2937

3038
jobs:
3139
cpp-linter:
3240
runs-on: ubuntu-latest
3341
steps:
3442
- uses: actions/checkout@v3
35-
- uses: cpp-linter/cpp-linter-action@v1
43+
- uses: cpp-linter/cpp-linter-action@v2
3644
id: linter
3745
env:
3846
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)