Skip to content

Commit

Permalink
docs: update README.md to remove useless section (#269)
Browse files Browse the repository at this point in the history
closes #268
  • Loading branch information
shenxianpeng authored Oct 1, 2024
1 parent 2aa86a5 commit 4afb97c
Showing 1 changed file with 3 additions and 16 deletions.
19 changes: 3 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,30 +33,17 @@ workflow [`step-summary`][step-summary], and Pull Request reviews (with
[`tidy-review`][tidy-review] or [`format-review`][format-review]).

> [!WARNING]
> We only support Linux runners using a Debian based Linux OS (like Ubuntu and many others).
> We only support Linux runners using a Debian-based Linux OS (like Ubuntu and many others).
>
> MacOS and Windows runners are supported as well.
## What's New

v2

* Change action from using docker to composite steps
* improve workflow runs times from 1m 24s (using v1) to 6-20s (for simple workflow runs).
* better support for the database input option (which was broken with the docker environment in v1).
* better support cross-compilation
* better support 3rd party libraries
* Includes many issues and enhancements. See [#87](https://github.com/cpp-linter/cpp-linter-action/issues/87) for details.

Refer [here](https://github.com/cpp-linter/cpp-linter-action/tree/v1) for previous versions.

## Usage

> [!NOTE]
> Python 3.10 needs to be installed in the docker image if your workflow is
> [running jobs in a container](https://docs.github.com/en/actions/using-jobs/running-jobs-in-a-container)
> (see discussion in [#185](https://github.com/cpp-linter/cpp-linter-action/issues/185)).
> Our intention is to synchronize with the default python version included with Ubuntu latest LTS releases.
> Our intention is to synchronize with the default Python version included with Ubuntu's latest LTS releases.
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/main/.github/workflows/cpp-linter.yml)

Expand All @@ -72,7 +59,7 @@ The content of the file should be in the following format.
with:
style: 'file' # Use .clang-format config file
tidy-checks: '' # Use .clang-tidy config file
# only 'update' a single comment in a pull request's thread.
# only 'update' a single comment in a pull request thread.
thread-comments: ${{ github.event_name == 'pull_request' && 'update' }}
- name: Fail fast?!
if: steps.linter.outputs.checks-failed > 0
Expand Down

1 comment on commit 4afb97c

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented on 4afb97c Oct 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cpp-Linter Report ⚠️

Some files did not pass the configured checks!

clang-format reports: 2 file(s) not formatted
  • docs/examples/demo/demo.hpp
  • docs/examples/demo/demo.cpp
clang-tidy reports: 7 concern(s)

Have any feedback or feature suggestions? Share it here.

Please sign in to comment.