chg: 👷 check for compatible licenses in CI (#42)

Author: ianardee

.github/workflows/license.yml

@@ -0,0 +1,40 @@
+#
+# Make sure dependencies use compatible licenses.
+#
+name: License Check
+
+on:
+  - pull_request
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    strategy:
+      matrix:
+        python-version: ["3.8"]
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Cache dependencies
+      uses: actions/cache@v2
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-lic-${{ hashFiles('**/requirements.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-lic-
+
+    - name: Install dependencies
+      run: |
+        python -m pip install pip
+        pip install pylic~=2.2
+        pip install -e .
+
+    - name: License check
+      run: |
+        pylic check

.github/workflows/linting.yml

@@ -1,3 +1,6 @@
+#
+# Run lint check and static code analysis.
+#
 name: Lint
 
 on:
@@ -11,21 +14,34 @@ jobs:
         python-version: ["3.8"]
     steps:
     - uses: actions/checkout@v2
+
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
+
+    - name: Cache dependencies
+      uses: actions/cache@v2
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-dev-${{ hashFiles('**/requirements.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-dev-
+
     - name: Install dependencies
       # We install the full dev requirements to make sure everything installs OK
       run: |
         python -m pip install pip
         pip install -e .[dev]
+
     - name: Analysing the code with Black
       run: |
         black --check .
+
     - name: Analysing the code with mypy
       run: |
         mypy --install-types --non-interactive ./mindee
+
     - name: Analysing the code with pylint
       run: |
         pylint ./mindee

.github/workflows/test.yml

@@ -1,3 +1,6 @@
+#
+# Run unit tests.
+#
 name: Test
 
 on:
@@ -27,9 +30,9 @@ jobs:
       uses: actions/cache@v2
       with:
         path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+        key: ${{ runner.os }}-test-${{ hashFiles('**/requirements.txt') }}
         restore-keys: |
-          ${{ runner.os }}-pip-
+          ${{ runner.os }}-test-
 
     - name: Install dependencies
       run: |

pyproject.toml

@@ -32,3 +32,14 @@ disable=[
   'consider-using-f-string',
   'consider-using-with',
 ]
+
+[tool.pylic]
+safe_licenses = [
+  "Apache Software License",
+  "MIT License",
+  "GNU Library or Lesser General Public License (LGPL)",
+  "Mozilla Public License 2.0 (MPL 2.0)",
+  "BSD License",
+  "Historical Permission Notice and Disclaimer (HPND)",
+]
+unsafe_packages = ["mindee"]