{"id":18996323,"url":"https://github.com/cpp-linter/cpp-linter-action","last_synced_at":"2025-04-07T07:08:10.626Z","repository":{"id":36964342,"uuid":"361605113","full_name":"cpp-linter/cpp-linter-action","owner":"cpp-linter","description":"A Github Action for linting C/C++ code integrating clang-tidy and clang-format to collect feedback provided in the form of file-annotations, thread-comments, workflow step-summary, and Pull Request reviews.","archived":false,"fork":false,"pushed_at":"2024-04-29T09:09:00.000Z","size":1372,"stargazers_count":83,"open_issues_count":4,"forks_count":19,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-05-02T02:51:24.712Z","etag":null,"topics":["clang-format","clang-tidy","github-actions","hacktoberfest","lint","linter","pull-requests","push","static-analysis"],"latest_commit_sha":null,"homepage":"https://cpp-linter.github.io/cpp-linter-action/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cpp-linter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-26T03:26:37.000Z","updated_at":"2024-06-08T04:20:13.051Z","dependencies_parsed_at":"2023-11-14T03:22:33.378Z","dependency_job_id":"4a3cfa54-1317-482f-94e3-3c14e82a8f71","html_url":"https://github.com/cpp-linter/cpp-linter-action","commit_stats":{"total_commits":122,"total_committers":11,"mean_commits":"11.090909090909092","dds":0.5819672131147541,"last_synced_commit":"e84192cfd882b66bc5b84d5d6f80fe7802161f34"},"previous_names":[],"tags_count":58,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cpp-linter%2Fcpp-linter-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cpp-linter%2Fcpp-linter-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cpp-linter%2Fcpp-linter-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cpp-linter%2Fcpp-linter-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cpp-linter","download_url":"https://codeload.github.com/cpp-linter/cpp-linter-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247608151,"owners_count":20965952,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clang-format","clang-tidy","github-actions","hacktoberfest","lint","linter","pull-requests","push","static-analysis"],"created_at":"2024-11-08T17:34:42.075Z","updated_at":"2025-04-07T07:08:10.594Z","avatar_url":"https://github.com/cpp-linter.png","language":null,"readme":"[file-annotations]: https://cpp-linter.github.io/cpp-linter-action/inputs-outputs/#file-annotations\n[thread-comments]: https://cpp-linter.github.io/cpp-linter-action/inputs-outputs/#thread-comments\n[step-summary]: https://cpp-linter.github.io/cpp-linter-action/inputs-outputs/#step-summary\n[tidy-review]: https://cpp-linter.github.io/cpp-linter-action/inputs-outputs/#tidy-review\n[format-review]: https://cpp-linter.github.io/cpp-linter-action/inputs-outputs/#format-review\n\n[io-doc]: https://cpp-linter.github.io/cpp-linter-action/inputs-outputs\n[recipes-doc]: https://cpp-linter.github.io/cpp-linter-action/examples\n\n[format-annotations-preview]: https://raw.githubusercontent.com/cpp-linter/cpp-linter-action/main/docs/images/annotations-clang-format.png\n[tidy-annotations-preview]: https://raw.githubusercontent.com/cpp-linter/cpp-linter-action/main/docs/images/annotations-clang-tidy.png\n[thread-comment-preview]: https://raw.githubusercontent.com/cpp-linter/cpp-linter-action/main/docs/images/comment.png\n[step-summary-preview]: https://raw.githubusercontent.com/cpp-linter/cpp-linter-action/main/docs/images/step-summary.png\n[tidy-review-preview]: https://raw.githubusercontent.com/cpp-linter/cpp-linter-action/main/docs/images/tidy-review.png\n[format-review-preview]: https://raw.githubusercontent.com/cpp-linter/cpp-linter-action/main/docs/images/format-review.png\n[format-suggestion-preview]: https://raw.githubusercontent.com/cpp-linter/cpp-linter-action/main/docs/images/format-suggestion.png\n\n\u003c!--README-start--\u003e\n\n# C/C++ Linter Action \u003csub\u003e\u003csup\u003e| clang-format \u0026 clang-tidy\u003c/sup\u003e\u003c/sub\u003e\n\n![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/cpp-linter/cpp-linter-action)\n[![GitHub marketplace](https://img.shields.io/badge/marketplace-C%2FC%2B%2B%20Linter-blue?logo=github)](https://github.com/marketplace/actions/c-c-linter)\n[![cpp-linter](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml)\n[![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)\n![GitHub](https://img.shields.io/github/license/cpp-linter/cpp-linter-action?label=license\u0026logo=github)\n\nA Github Action for linting C/C++ code integrating clang-tidy and clang-format\nto collect feedback provided in the form of\n[`file-annotations`][file-annotations], [`thread-comments`][thread-comments],\nworkflow [`step-summary`][step-summary], and Pull Request reviews (with\n[`tidy-review`][tidy-review] or [`format-review`][format-review]).\n\n\u003e [!WARNING]\n\u003e We only support Linux runners using a Debian-based Linux OS (like Ubuntu and many others).\n\u003e\n\u003e MacOS and Windows runners are supported as well.\n\n## Usage\n\n\u003e [!NOTE]\n\u003e Python 3.10 needs to be installed in the docker image if your workflow is\n\u003e [running jobs in a container](https://docs.github.com/en/actions/using-jobs/running-jobs-in-a-container)\n\u003e (see discussion in [#185](https://github.com/cpp-linter/cpp-linter-action/issues/185)).\n\u003e Our intention is to synchronize with the default Python version included with Ubuntu's latest LTS releases.\n\nCreate 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)\n\nThe content of the file should be in the following format.\n\n```yaml\n    steps:\n      - uses: actions/checkout@v4\n      - uses: cpp-linter/cpp-linter-action@v2\n        id: linter\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n        with:\n          style: 'file'  # Use .clang-format config file\n          tidy-checks: '' # Use .clang-tidy config file\n          # only 'update' a single comment in a pull request thread.\n          thread-comments: ${{ github.event_name == 'pull_request' \u0026\u0026 'update' }}\n      - name: Fail fast?!\n        if: steps.linter.outputs.checks-failed \u003e 0\n        run: exit 1\n```\n\nFor all explanations of our available input parameters and output variables, see our\n[Inputs and Outputs document][io-doc].\n\nSee also our [example recipes][recipes-doc].\n\n## Used By\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/Microsoft\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/6154722?s=200\u0026v=4\" alt=\"Microsoft\" width=\"28\"/\u003e\u003c/a\u003e\n  \u003cstrong\u003eMicrosoft\u003c/strong\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"https://github.com/apache\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/47359?s=200\u0026v=4\" alt=\"Apache\" width=\"28\"/\u003e\u003c/a\u003e\n  \u003cstrong\u003eApache\u003c/strong\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"https://github.com/nasa\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/848102?s=200\u0026v=4\" alt=\"NASA\" width=\"28\"/\u003e\u003c/a\u003e\n  \u003cstrong\u003eNASA\u003c/strong\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"https://github.com/samsung\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/6210390?s=200\u0026v=4\" alt=\"Samsung\" width=\"28\"/\u003e\u003c/a\u003e\n  \u003cstrong\u003eSamsung\u003c/strong\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"https://github.com/TheAlgorithms\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/20487725?s=200\u0026v=4\" alt=\"TheAlgorithms\" width=\"28\"/\u003e\u003c/a\u003e\n  \u003cstrong\u003eTheAlgorithms\u003c/strong\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"https://github.com/CachyOS\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/85452089?s=200\u0026v=4\" alt=\"CachyOS\" width=\"28\"/\u003e\u003c/a\u003e\n  \u003cstrong\u003eCachyOS\u003c/strong\u003e\u0026nbsp;\u0026nbsp;\n  \u003c/br\u003e\n  \u003ca href=\"https://github.com/nextcloud\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/19211038?s=200\u0026v=4\" alt=\"Nextcloud\" width=\"28\"/\u003e\u003c/a\u003e\n  \u003cstrong\u003eNextcloud\u003c/strong\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"https://github.com/jupyter-xeus\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/58793052?s=200\u0026v=4\" alt=\"Jupyter\" width=\"28\"/\u003e\u003c/a\u003e\n  \u003cstrong\u003eJupyter\u003c/strong\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"https://github.com/nnstreamer\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/60992508?s=200\u0026v=4\" alt=\"NNStreamer\" width=\"28\"/\u003e\u003c/a\u003e\n  \u003cstrong\u003eNNStreamer\u003c/strong\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"https://github.com/imgproxy\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/48099924?s=200\u0026v=4\" alt=\"imgproxy\" width=\"28\"/\u003e\u003c/a\u003e\n  \u003cstrong\u003eimgproxy\u003c/strong\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"https://github.com/Zondax\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/34372050?s=200\u0026v=4\" alt=\"Zondax\" width=\"28\"/\u003e\u003c/a\u003e\n  \u003cstrong\u003eZondax\u003c/strong\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"https://github.com/AppNeta\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/3374594?s=200\u0026v=4\" alt=\"AppNeta\" width=\"28\"/\u003e\u003c/a\u003e\n  \u003cstrong\u003eAppNeta\u003c/strong\u003e\u0026nbsp;\u0026nbsp;\n  \u003c/br\u003e\n  \u003ca href=\"https://github.com/chocolate-doom\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/6140118?s=200\u0026v=4\" alt=\"Chocolate Doom\" width=\"28\"/\u003e\u003c/a\u003e\n  \u003cstrong\u003eChocolate Doom\u003c/strong\u003e\n  \u003cstrong\u003e and \u003ca href=\"https://github.com/cpp-linter/cpp-linter-action/network/dependents\"\u003emany more\u003c/a\u003e.\u003c/strong\u003e\n\u003c/p\u003e\n\n## Example\n\n### Annotations\n\nUsing [`file-annotations`][file-annotations]:\n\n#### clang-format annotations\n\n![clang-format annotations][format-annotations-preview]\n\n#### clang-tidy annotations\n\n![clang-tidy annotations][tidy-annotations-preview]\n\n### Thread Comment\n\nUsing [`thread-comments`][thread-comments]:\n\n![sample thread-comment][thread-comment-preview]\n\n### Step Summary\n\nUsing [`step-summary`][step-summary]:\n\n![step summary][step-summary-preview]\n\n### Pull Request Review\n\n#### Only clang-tidy\n\nUsing [`tidy-review`][tidy-review]:\n\n![sample tidy-review][tidy-review-preview]\n\n#### Only clang-format\n\nUsing [`format-review`][format-review]:\n\n![sample format-review][format-review-preview]\n\n![sample format-suggestion][format-suggestion-preview]\n\n## Add C/C++ Linter Action badge in README\n\nYou can show C/C++ Linter Action status with a badge in your repository README\n\nExample\n\n```markdown\n[![cpp-linter](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml)\n```\n\n[![cpp-linter](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml/badge.svg)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml)\n\n## Have question or feedback?\n\nTo provide feedback (requesting a feature or reporting a bug) please post to [issues](https://github.com/cpp-linter/cpp-linter-action/issues).\n\n## License\n\nThe scripts and documentation in this project are released under the [MIT License](https://github.com/cpp-linter/cpp-linter-action/blob/main/LICENSE)\n\n\u003c!--README-end--\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcpp-linter%2Fcpp-linter-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcpp-linter%2Fcpp-linter-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcpp-linter%2Fcpp-linter-action/lists"}