solves #98

.github/workflows/mkdocs-deploy.yml

@@ -13,13 +13,13 @@ jobs:
         with:
           python-version: 3.x
       - name: Install python action for doc extraction
-        run: pip install . -r docs/requirements.txt
+        run: pip install -r docs/requirements.txt
       - name: check mkdocs build
-        if: github.ref != 'refs/heads/master'
+        # if: github.ref != 'refs/heads/master'
         run: mkdocs build
-      - name: Build docs and deploy to gh-pages
-        if: github.ref == 'refs/heads/master'
-        run: |
-          git config user.name 'github-actions'
-          git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
-          mkdocs gh-deploy --force
+      # - name: Build docs and deploy to gh-pages
+      #   if: github.ref == 'refs/heads/master'
+      #   run: |
+      #     git config user.name 'github-actions'
+      #     git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
+      #     mkdocs gh-deploy --force

.pre-commit-config.yaml

@@ -4,33 +4,5 @@ repos:
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
-      - id: check-docstring-first
       - id: check-added-large-files
       - id: check-yaml
-      - id: check-toml
-      - id: requirements-txt-fixer
-  - repo: https://github.com/python/black
-    rev: '22.6.0'
-    hooks:
-      - id: black
-        args: ["--diff"]
-  - repo: https://github.com/pycqa/pylint
-    rev: v2.14.5
-    hooks:
-      - id: pylint
-        name: pylint (action code)
-        types: [python]
-        exclude: "^(docs/|tests/|setup.py$)"
-        additional_dependencies: [pyyaml, requests]
-  - repo: local
-    # this is a "local" hook to run mypy (see https://pre-commit.com/#repository-local-hooks)
-    # because the mypy project doesn't seem to be compatible with pre-commit hooks
-    hooks:
-      - id: mypy
-        name: mypy
-        description: type checking with mypy tool
-        language: python
-        types: [python]
-        entry: mypy
-        exclude: "^(docs/|setup.py$)"
-        additional_dependencies: [mypy, types-pyyaml, types-requests, rich, requests, pytest, pyyaml, '.']

Dockerfile

@@ -14,9 +14,7 @@ LABEL maintainer="shenxianpeng <[email protected]>"
 
 RUN apt-get update && apt-get -y install python3-pip
 
-COPY cpp_linter/ pkg/cpp_linter/
-COPY pyproject.toml pkg/pyproject.toml
-RUN python3 -m pip install pkg/
+RUN python3 -m pip install cpp-linter
 
 # github action args use the CMD option
 # See https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsargs

README.md

@@ -7,7 +7,6 @@
 [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/cpp-linter/cpp-linter-action/cpp-linter?label=cpp-linter&logo=Github&style=flat-square)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/cpp-linter.yml)
 [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/cpp-linter/cpp-linter-action/MkDocs%20Deploy?label=docs&logo=Github&style=flat-square)](https://github.com/cpp-linter/cpp-linter-action/actions/workflows/mkdocs-deploy.yml)
 ![GitHub](https://img.shields.io/github/license/cpp-linter/cpp-linter-action?label=license&logo=github&style=flat-square)
-[![codecov](https://codecov.io/gh/cpp-linter/cpp-linter-action/branch/master/graph/badge.svg?token=4SF7UEDEZ2)](https://codecov.io/gh/cpp-linter/cpp-linter-action)
 
 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.
 
@@ -187,7 +186,7 @@ jobs:
           directory: ${{ runner.temp }}/llvm
 
       - name: Install linter python package
-        run: python3 -m pip install git+https://github.com/cpp-linter/cpp-linter-action@v1
+        run: python3 -m pip install cpp-linter
 
       - name: run linter as a python package
         id: linter
@@ -219,7 +218,7 @@ is equivalent to
 
 ```yaml
       - name: Install linter python package
-        run: python3 -m pip install git+https://github.com/cpp-linter/cpp-linter-action@v1
+        run: python3 -m pip install cpp-linter
 
       - name: run linter as a python package
         run: |