Merge pull request #1 from octue/devops/make-tests-work

Add CI workflows

Author: thclark

.github/workflows/cd.yml

@@ -15,6 +15,14 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v2
 
+      - name: Test package is publishable with PyPI test server
+        uses: JRubics/[email protected]
+        with:
+          python_version: "3.9"
+          pypi_token: ${{ secrets.TEST_PYPI_TOKEN }}
+          repository_name: "testpypi"
+          repository_url: "https://test.pypi.org/legacy/"
+
       - name: Publish latest package to PyPI
         uses: JRubics/[email protected]
         with:
@@ -36,14 +44,15 @@ jobs:
         run: pip install poetry
 
       - name: Get package version
-        run: echo "PACKAGE_VERSION=$(poetry version -s)" >> $GITHUB_ENV
+        id: version
+        run: echo "::set-output name=package_version::$(poetry version -s)"
 
       - name: Create release
         uses: actions/create-release@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, no need to create your own.
         with:
-          tag_name: ${{ env.PACKAGE_VERSION }}
+          tag_name: ${{ steps.version.outputs.package_version }}
           release_name: ${{ github.event.pull_request.title }}
           body: ${{ github.event.pull_request.body }}
           draft: false

.github/workflows/ci.yml

@@ -1,7 +1,15 @@
+name: ci
+
 on:
   pull_request:
     branches:
       - main
+  workflow_dispatch:
+    inputs:
+      debug_enabled:
+        description: "Enable tmate debug"
+        type: boolean
+        default: "false"
 
 jobs:
   check-semantic-version:
@@ -34,23 +42,26 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python: ["3.6", "3.7", "3.8", "3.9"]
-        django: ["2.2", "3.0", "3.1"]
+        python: ["3.8", "3.9", "3.10"]
         os: [ubuntu-latest] # [ubuntu-latest, windows-latest, macos-latest] for full coverage but this gets expensive quickly
     runs-on: ${{ matrix.os }}
+
     services:
-      # See: https://docs.github.com/en/actions/using-containerized-services/creating-postgresql-service-containers
-      pg_host:
-        image: postgres:13.0
+      postgres:
+        image: kartoza/postgis:13.0
         env:
-          POSTGRES_DB: pg_db
-          POSTGRES_USER: pg_user
-          POSTGRES_PASSWORD: pg_password
+          POSTGRES_DB: postgres_db
+          POSTGRES_USER: postgres_user
+          POSTGRES_PASSWORD: postgres_password
+          POSTGRES_MULTIPLE_EXTENSIONS: postgis,hstore,postgis_topology,postgis_raster,pgrouting
+        ports:
+          - 5432:5432
         options: >-
           --health-cmd pg_isready
           --health-interval 10s
           --health-timeout 5s
           --health-retries 5
+
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v2
@@ -67,13 +78,16 @@ jobs:
         # For more advanced configuration see https://github.com/ymyzk/tox-gh-actions
       - name: Install tox and plugins
         run: |
-          pip install --upgrade pip
-          pip install tox@^3.24.5 tox-gh-actions@^2.9.1 tox-poetry@^0.4.1
+          python -m pip install --upgrade pip
+          python -m pip install tox==3.24.5 tox-gh-actions==2.9.1 tox-poetry==0.4.1
+
+      - name: Setup tmate session [DEBUG]
+        if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled == 'true'}}
+        uses: mxschmitt/action-tmate@v3
 
+      # For more advanced configuration see https://github.com/ymyzk/tox-gh-actions
       - name: Run tests using tox
         run: tox
-        env:
-          DATABASE_URL: postgresql://pg_user:pg_password@pg_host/pg_db
 
       - name: Upload coverage to Codecov
         # This seems redundant inside the test matrix but actually isn't, since different
@@ -83,20 +97,3 @@ jobs:
           file: coverage.xml
           fail_ci_if_error: true
           token: ${{ secrets.CODECOV_TOKEN }}
-
-  test-publish:
-    if: "!contains(github.event.head_commit.message, 'skipci')"
-    runs-on: ubuntu-latest
-    needs: [check-semantic-version, run-tests]
-    steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v2
-
-      - name: Test package is publishable with PyPI test server
-        uses: JRubics/[email protected]
-        with:
-          python_version: "3.9"
-          pypi_token: ${{ secrets.TEST_PYPI_TOKEN }}
-          repository_name: "testpypi"
-          repository_url: "https://test.pypi.org/legacy/"
-          skip_existing: true

.github/workflows/update_pr.yml

@@ -0,0 +1,35 @@
+# This workflow updates the pull request description with an auto-generated section containing the categorised commit
+# message headers of the commits since the last pull request merged into main. The auto generated section is enveloped
+# between two comments: "<!--- START AUTOGENERATED NOTES --->" and "<!--- END AUTOGENERATED NOTES --->". Anything
+# outside these in the description is left untouched. Auto-generated updates can be skipped for a commit if
+# "skipci" is in the commit message body.
+
+name: update-pr
+
+on: [pull_request]
+
+jobs:
+  description:
+    if: "!contains(github.event.head_commit.message, 'skipci')"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          # Set fetch-depth to 0 to fetch all commit history (necessary for compiling pull request description).
+          fetch-depth: 0
+
+      - name: Install release note compiler
+        run: pip install git+https://github.com/octue/conventional-commits
+
+      - name: Compile new pull request description
+        run: |
+          echo 'PULL_REQUEST_NOTES<<EOF' >> $GITHUB_ENV
+          echo "$(compile-release-notes PULL_REQUEST_START --pull-request-url=${{ github.event.pull_request.url }} --api-token=${{ secrets.GITHUB_TOKEN }})" >> $GITHUB_ENV
+          echo EOF >> $GITHUB_ENV
+
+      - name: Update pull request body
+        uses: riskledger/update-pr-description@v2
+        with:
+          body: ${{ env.PULL_REQUEST_NOTES }}
+          token: ${{ secrets.GITHUB_TOKEN }}

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = {py37,py38,py39}-dj{31}-channels{30}-{sqlite,postgres}
+envlist = {py38,py39,py310}-dj{32}-channels{30}-{sqlite,postgres}
 isolated_build = True
 
 [testenv]
@@ -14,12 +14,12 @@ commands =
     coverage report --show-missing
     coverage xml
 deps =
-    dj31: Django>=3.1,<3.2
+    dj32: Django>=3.2,<3.3
     channels30: channels>=3.0,<=3.1
-    postgres: psycopg2==2.8.5 --no-binary psycopg2
+    postgres: psycopg2
 
 [gh-actions]
 python =
-    3.7: py37
     3.8: py38
     3.9: py39
+    3.10: py310