Add workflow lint & linckcheck (#133)

Signed-off-by: Bennu-Li <yunmei.li@zilliz.com>

.github/workflows/linkcheck.yaml

@@ -0,0 +1,37 @@
+name: linkcheck
+
+on:
+  push:
+    branches: main
+  pull_request:
+    branches: main
+
+env:
+  POETRY_VERSION: "1.3.1"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.8"
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install poetry
+        run: |
+          pipx install poetry==$POETRY_VERSION
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: poetry
+      - name: Install dependencies
+        run: |
+          poetry install --with docs
+      - name: Build the docs
+        run: |
+          make docs_build
+      - name: Analyzing the docs with linkcheck
+        run: |
+          make docs_linkcheck

.github/workflows/lint.yaml

@@ -0,0 +1,34 @@
+name: lint
+
+on:
+  push:
+    branches: main
+  pull_request:
+    branches: main
+
+env:
+  POETRY_VERSION: "1.3.1"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.8"
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install poetry
+        run: |
+          pipx install poetry==$POETRY_VERSION
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: poetry
+      - name: Install dependencies
+        run: |
+          poetry install
+      - name: Analysing the code with our lint
+        run: |
+          make lint

.github/workflows/pylint.yaml

@@ -9,7 +9,7 @@ on:
       - 'gptcache/**'
       - 'tests/**'
       - '!**.md'
-      - '.github/workflows/pylint.yml'
+      - '.github/workflows/**'
 jobs:
   run:
     runs-on: ubuntu-latest
@@ -22,4 +22,4 @@ jobs:
     - name: Python pylint
       run: |
         pip install pylint==2.10.2
-        pylint --rcfile=pylint.conf --output-format=colorized gptcache && pylint --rcfile=pylint.conf --output-format=colorized tests.unit_tests
+        make pylint_check

Makefile

@@ -22,3 +22,24 @@ create_conda_env:
 
 remove_conda_env:
 	@bash ./scripts/manage_conda_env.sh remove
+
+docs_build:
+	cd docs && poetry run make html
+
+docs_clean:
+	cd docs && poetry run make clean
+
+docs_linkcheck:
+	poetry run linkchecker docs/_build/html/index.html
+
+PYTHON_FILES=.
+lint: PYTHON_FILES=.
+lint_diff: PYTHON_FILES=$(shell git diff --name-only --diff-filter=d master | grep -E '\.py$$')
+
+lint lint_diff:
+	poetry run mypy $(PYTHON_FILES)
+	poetry run black $(PYTHON_FILES) --check
+	poetry run ruff .
+
+pylint_check:
+	pylint --rcfile=pylint.conf --output-format=colorized gptcache && pylint --rcfile=pylint.conf --output-format=colorized tests.unit_tests

poetry.toml

@@ -0,0 +1,5 @@
+[virtualenvs]
+in-project = true
+
+[installer]
+modern-installation = false