Improve GitHub Actions workflows (#61)

* Set bash as default shell in test workflow

* Cache pip folder in linting job

* Enable cache on Windows

* Create local poetry venv instead of in default location

* Set cache keys with OS name and Python version

* Add comment for cron schedule on quality workflow

* Skip dependency installation on cache hit

* Move if statement below step name

* Limit documentation deployment to successful builds

* Add Python version to step name

* Rename variables in test workflow matrix

* Override Python setup in code scanning job

* Ensure CodeQL analysis uses correct Python location

* Revert changes to Python setup in CodeQL job

* Add name keyword to docs job

Uses YAML structure that is consistent with other workflows

* Use GitHub Actions runner in job name

* Use same variable for workflow job name and runner

Author: klane

.github/workflows/docs.yml

@@ -10,7 +10,8 @@ on:
       - 'poetry.lock'
 
 jobs:
-  Build:
+  build:
+    name: Build
     runs-on: ubuntu-latest
 
     steps:
@@ -20,27 +21,32 @@ jobs:
       - name: Set up Python
         uses: actions/[email protected]
 
-      - name: Install Poetry
-        uses: Gr1N/setup-poetry@v4
+      - name: Get Python version
+        id: python-version
+        run: echo ::set-output name=version::$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))")
 
-      - name: Write environment information to a file
-        run: |
-          pwd > environment
-          python --version >> environment
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
 
       - name: Restore cache
+        id: cache
         uses: actions/[email protected]
         with:
-          path: ~/.cache/pypoetry
-          key: poetry|${{ hashFiles('environment') }}|${{ hashFiles('poetry.lock') }}
+          path: .venv
+          key: poetry-${{ runner.os }}-${{ steps.python-version.outputs.version }}-${{ hashFiles('poetry.lock') }}
 
       - name: Install dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
         run: poetry install
 
       - name: Build documentation
         run: poetry run make -C docs html
 
       - name: Deploy documentation
+        if: success()
         uses: JamesIves/[email protected]
         with:
           branch: gh-pages

.github/workflows/quality.yml

@@ -42,15 +42,17 @@ jobs:
       - name: Set up Python
         uses: actions/[email protected]
 
-      - name: Hash Python version
-        id: hash
-        run: echo ::set-output name=hash::$(python --version | sha256sum | cut -d' ' -f1)
+      - name: Get Python version
+        id: python-version
+        run: echo ::set-output name=version::$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))")
 
       - name: Restore cache
         uses: actions/[email protected]
         with:
-          path: ~/.cache/pre-commit
-          key: pre-commit|${{ steps.hash.outputs.hash }}|${{ hashFiles('.pre-commit-config.yaml') }}
+          path: |
+            ~/.cache/pip
+            ~/.cache/pre-commit
+          key: pre-commit-${{ runner.os }}-${{ steps.python-version.outputs.version }}-${{ hashFiles('.pre-commit-config.yaml') }}
 
       - name: Run pre-commit
         uses: pre-commit/[email protected]

.github/workflows/test.yml

@@ -14,55 +14,47 @@ on:
 
 jobs:
   test:
-    name: '${{ matrix.os_name }}: Python ${{ matrix.python }}'
-    runs-on: ${{ matrix.os }}
+    name: ${{ matrix.os }} / ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}-latest
+    defaults:
+      run:
+        shell: bash
 
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        python: [3.7, 3.8, 3.9]
-        include:
-          - os: ubuntu-latest
-            os_name: Linux
-            poetry_cache: ~/.cache/pypoetry
-
-          - os: macos-latest
-            os_name: macOS
-            poetry_cache: ~/Library/Caches/pypoetry
-
-          - os: windows-latest
-            os_name: Windows
-            poetry_cache: ~\AppData\Local\pypoetry\Cache
+        os: [Ubuntu, macOS, Windows]
+        python-version: [3.7, 3.8, 3.9]
 
     steps:
       - name: Checkout
         uses: actions/[email protected]
 
-      - name: Set up Python
+      - name: Set up Python ${{ matrix.python-version }}
         uses: actions/[email protected]
         with:
-          python-version: ${{ matrix.python }}
+          python-version: ${{ matrix.python-version }}
 
-      - name: Install Poetry
-        uses: Gr1N/setup-poetry@v4
+      - name: Get Python version
+        id: python-version
+        run: echo ::set-output name=version::$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))")
 
-      - name: Write environment information to a file
-        run: |
-          pwd > environment
-          python --version >> environment
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
 
       - name: Restore cache
-        id: poetry-cache
+        id: cache
         uses: actions/[email protected]
-        if: runner.os != 'Windows'
         with:
-          path: ${{ matrix.poetry_cache }}
-          key: poetry|${{ hashFiles('environment') }}|${{ hashFiles('poetry.lock') }}
+          path: .venv
+          key: poetry-${{ runner.os }}-${{ steps.python-version.outputs.version }}-${{ hashFiles('poetry.lock') }}
 
       - name: Install dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
         run: poetry install
-        if: steps.poetry-cache.outputs.cache-hit != 'true'
 
       - name: Run tests
         run: poetry run pytest tests/ --cov=torchts
@@ -71,8 +63,8 @@ jobs:
         run: poetry run coverage xml
 
       - name: Upload coverage report
-        uses: codecov/codecov-action@v1
         if: success()
+        uses: codecov/codecov-action@v1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           file: ./coverage.xml