Add CI/CD (#1)

* Add CI/CD pipeline with linting and formatting checks

* Add release CI/CD workflow for automatic package release on PyPi

Author: vis4rd

.github/actions/install_dependencies/action.yml

@@ -0,0 +1,21 @@
+name: Install dependencies
+
+inputs:
+  python_version:
+    description: Version of python to prepare
+    required: false
+    default: "3.11"
+
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ inputs.python_version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ inputs.python_version }}
+    - name: Install dependencies
+      shell: bash
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install -r ci_requirements.txt

.github/workflows/quality.yml

@@ -0,0 +1,70 @@
+name: Quality
+
+on:
+  pull_request:
+    paths:
+      - 'pydocstyle_gitlab_code_quality/**'
+      - 'ci_requirements.txt'
+      - 'pyproject.toml'
+
+jobs:
+  pylint:
+    name: Pylint - Python ${{ matrix.python_version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python_version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/install_dependencies
+        with:
+            python_version: ${{ matrix.python_version }}
+      - name: Run pylint
+        run: |
+          pylint --output-format=colorized $(git ls-files '*.py')
+  mypy:
+    name: Mypy - Python ${{ matrix.python_version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python_version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/install_dependencies
+        with:
+          python_version: ${{ matrix.python_version }}
+      - name: Run mypy
+        run: |
+          mypy --config-file pyproject.toml .
+  isort:
+    name: Isort - Python ${{ matrix.python_version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python_version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/install_dependencies
+        with:
+          python_version: ${{ matrix.python_version }}
+      - name: Run isort
+        run: |
+          isort --settings-file pyproject.toml --check --diff --color .
+  black:
+    name: Black - Python ${{ matrix.python_version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python_version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/install_dependencies
+        with:
+          python_version: ${{ matrix.python_version }}
+      - name: Run black
+        run: |
+          black --config pyproject.toml --check --diff --color .

.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release to PyPi
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish_to_pypi:
+    name: Publish package to PyPi
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.11
+      - name: Install build and publish dependencies
+        shell: bash
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build twine
+      - name: Build package
+        shell: bash
+        run: |
+          python -m build
+      - name: Publish to PyPi
+        shell: bash
+        run: |
+          python -m twine upload --non-interactive --username ${{ secrets.PYPI_USERNAME }} --password ${{ secrets.PYPI_PASSWORD }} --repository pypi dist/*

.vscode/extensions.json

@@ -0,0 +1,12 @@
+{
+    "recommendations": [
+        "bungcip.better-toml",
+        "kevinrose.vsc-python-indent",
+        "ms-python.black-formatter",
+        "ms-python.isort",
+        "ms-python.mypy-type-checker",
+        "ms-python.pylint",
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+    ]
+}

.vscode/settings.json

@@ -17,13 +17,10 @@
     "python.analysis.typeCheckingMode": "basic",
     "python.languageServer": "Pylance",
 
-    "python.linting.mypyEnabled": true,
-    "python.linting.pylintEnabled": true,
-
     "black-formatter.args": [ "--config", "pyproject.toml" ],
     "isort.args": [ "--settings-file", "pyproject.toml" ],
+    "mypy-type-checker.args": ["--config-file", "pyproject.toml"],
     "pylint.args": [ "--rcfile", "pyproject.toml" ],
-    "python.linting.mypyArgs": [ "--config-file", "pyproject.toml" ],
 
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": false,

ci_requirements.txt

@@ -0,0 +1,4 @@
+black~=23.3.0
+isort[colors]~=5.11.0
+mypy~=1.4.1
+pylint~=2.17.4