update ci config

karlicoss · Nov 10, 2020 · aa2ddbd · aa2ddbd
1 parent f6ca727
commit aa2ddbd
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 14 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -1,21 +1,31 @@
 # see https://github.com/karlicoss/pymplate for up-to-date reference
 
 name: CI
-on: [push]
+on:
+  push:
+    branches: '*'
+    tags: 'v[0-9]+.*' # only trigger on 'release' tags for PyPi
+    # Ideally I would put this in the pypi job... but github syntax doesn't allow for regexes there :shrug:
+    # P.S. fuck made up yaml DSLs.
+    # TODO cron?
+  workflow_dispatch: # needed to trigger workflows manually
+
+env:
+  # useful for scripts & sometimes tests to know
+  CI: true
 
 jobs:
   build:
-    runs-on: ubuntu-latest
-
     strategy:
       matrix:
+        platform: [ubuntu-latest] # , macos-latest] # TODO windows-latest??
         python-version: [3.6, 3.7, 3.8]
-    # TODO shit. matrix is going to prevent from twine deployments because of version conflicts??
-    # add 'and' clause??
+
+    runs-on: ${{ matrix.platform }}
 
     steps:
-    # fuck me. https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path
-    - run: echo "::add-path::$HOME/.local/bin"
+    # ugh https://github.com/actions/toolkit/blob/main/docs/commands.md#path-manipulation
+    - run: echo "$HOME/.local/bin" >> $GITHUB_PATH
 
     - uses: actions/setup-python@v1
       with:
@@ -26,16 +36,23 @@ jobs:
         submodules: recursive
 
     # uncomment for SSH debugging
-    # - uses: mxschmitt/action-tmate@v2
+    # - uses: mxschmitt/action-tmate@v3
 
     - run: .ci/run
 
+    - uses: actions/upload-artifact@v2
+      with:
+        name: .mypy-coverage_${{ matrix.platform }}_${{ matrix.python-version }}
+        path: .mypy-coverage/
+
+
   pypi:
     runs-on: ubuntu-latest
     needs: build
 
     steps:
-    - run: echo "::add-path::$HOME/.local/bin"
+    # ugh https://github.com/actions/toolkit/blob/main/docs/commands.md#path-manipulation
+    - run: echo "$HOME/.local/bin" >> $GITHUB_PATH
 
     - uses: actions/setup-python@v1
       with:
@@ -54,10 +71,8 @@ jobs:
 
     - name: 'release to pypi'
       # always deploy tags to release pypi
-      # TODO filter release tags only?
+      # NOTE: release tags are guarded by on: push: tags on the top
       if: startsWith(github.event.ref, 'refs/tags')
       env:
         TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
       run: pip3 install --user wheel twine && .ci/release
-
-# todo generate mypy coverage artifacts?
diff --git a/setup.py b/setup.py
@@ -44,7 +44,7 @@ def main():
             'testing': [
                 'pytest', 'pytz', 'patchy',
                 'pylint',
-                'mypy',
+                'mypy', 'lxml',
                 'bandit',
 
                 'more-itertools',

diff --git a/tox.ini b/tox.ini
@@ -13,7 +13,11 @@ commands =
 [testenv:mypy]
 commands =
     pip install -e .[testing]
-    python -m mypy src {posargs}
+    python -m mypy src                               \
+                   # txt report is a bit more convenient to view on CI
+                   --txt-report  .mypy-coverage      \
+                   --html-report .mypy-coverage      \
+                   {posargs}
 
 
 [testenv:pylint]