CI overhaul (#12)

Author: crusaderky

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,3 @@
+- [ ] Closes #xxxx
+- [ ] Tests added / passed
+- [ ] Passes `pre-commit run --all-files`

.github/workflows/docs.yml

@@ -12,16 +12,19 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
 
-      - name: Setup conda environment
-        uses: goanpeca/setup-miniconda@v1
+      - name: Setup Conda Environment
+        uses: conda-incubator/setup-miniconda@v2
         with:
-          miniconda-version: latest
-          auto-update-conda: true
-          python-version: 3.7
+          miniforge-variant: Mambaforge
+          miniforge-version: latest
+          condarc-file: ci/condarc
+          use-mamba: true
+          python-version: '3.8'
           environment-file: ci/requirements-docs.yml
           activate-environment: recursive_diff-docs
-          auto-activate-base: false
 
       - name: conda info
         shell: bash -l {0}
@@ -37,7 +40,7 @@ jobs:
 
       - name: Build docs
         shell: bash -l {0}
-        run: sphinx-build -W -n -j auto -b html -d build/doctrees doc build/html
+        run: sphinx-build -n -j auto -b html -d build/doctrees doc build/html
 
       - uses: actions/upload-artifact@v1
         with:

.github/workflows/lint.yml

@@ -0,0 +1,16 @@
+name: Linting
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: ['*']
+
+jobs:
+  checks:
+    name: pre-commit hooks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - uses: pre-commit/[email protected]

.github/workflows/pre-commit.yml

@@ -13,10 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version:
-          - '3.6'
-          - '3.7'
-          - '3.8'
+        python-version: ['3.8', '3.9', '3.10']
         requirements:
           - latest
           - minimal
@@ -26,26 +23,27 @@ jobs:
           - macos
           - windows
         exclude:
-          - python-version: '3.7'
+          - python-version: '3.9'
             requirements: minimal
-          - python-version: '3.8'
+          - python-version: '3.10'
             requirements: minimal
-          - python-version: '3.7'
-            requirements: no_optionals
 
     steps:
       - name: Checkout
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
 
       - name: Setup Conda Environment
-        uses: goanpeca/setup-miniconda@v1
+        uses: conda-incubator/setup-miniconda@v2
         with:
-          miniconda-version: latest
-          auto-update-conda: true
+          miniforge-variant: Mambaforge
+          miniforge-version: latest
+          condarc-file: ci/condarc
+          use-mamba: true
           python-version: ${{ matrix.python-version }}
           environment-file: ci/requirements-${{ matrix.requirements }}.yml
           activate-environment: recursive_diff
-          auto-activate-base: false
 
       - name: conda info
         shell: bash -l {0}

.github/workflows/pytest.yml

@@ -0,0 +1,39 @@
+repos:
+  - repo: https://github.com/MarcoGorelli/absolufy-imports
+    rev: v0.3.1
+    hooks:
+      - id: absolufy-imports
+        name: absolufy-imports
+  - repo: https://github.com/pycqa/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        language_version: python3
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.31.1
+    hooks:
+      - id: pyupgrade
+        args:
+          - --py38-plus
+  - repo: https://github.com/psf/black
+    rev: 22.1.0
+    hooks:
+      - id: black
+        language_version: python3
+        exclude: versioneer.py
+        args:
+          - --target-version=py38
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 4.0.1
+    hooks:
+      - id: flake8
+        language_version: python3
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.942
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          # Typed libraries
+          - numpy
+          - pandas
+          - xarray

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 recursive_diff
 =============
 [![doc-badge](https://github.com/crusaderky/recursive_diff/workflows/Documentation/badge.svg)](https://github.com/crusaderky/recursive_diff/actions)
-[![lint-badge](https://github.com/crusaderky/recursive_diff/workflows/Lint/badge.svg)](https://github.com/crusaderky/recursive_diff/actions)
+[![lint-badge](https://github.com/crusaderky/recursive_diff/workflows/Linting/badge.svg)](https://github.com/crusaderky/recursive_diff/actions)
 [![pytest-badge](https://github.com/crusaderky/recursive_diff/workflows/pytest/badge.svg)](https://github.com/crusaderky/recursive_diff/actions)
 [![codecov-badge](https://codecov.io/gh/crusaderky/recursive_diff/branch/master/graph/badge.svg)](https://codecov.io/gh/crusaderky/recursive_diff/branch/master)
 

README.md

@@ -0,0 +1,9 @@
+channels:
+  - conda-forge
+  - defaults
+channel_priority: true
+auto_activate_base: false
+remote_backoff_factor: 20
+remote_connect_timeout_secs: 20.0
+remote_max_retries: 10
+remote_read_timeout_secs: 60.0

ci/condarc

@@ -3,8 +3,8 @@ channels:
   - conda-forge
   - defaults
 dependencies:
-  - python=3.7
+  - python=3.8
   - dask
-  - sphinx=2
+  - sphinx
   - sphinx_rtd_theme
   - xarray

ci/requirements-docs.yml

@@ -4,7 +4,9 @@ channels:
   - defaults
 dependencies:
   - pytest
+  - packaging
   - coverage
+
   - xarray
   - dask
   - h5netcdf  # NetCDF engine