Merge branch 'github-actions'

Author: PeterJCLaw

.circleci/config.yml

@@ -0,0 +1,113 @@
+name: Check
+
+on:
+  pull_request:
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-20.04
+
+    strategy:
+      matrix:
+        python-version: ["3.6", "3.7", "3.8", "3.9"]
+        django-version: ["2.2", "3.0", "3.1", "3.2", "4.0"]
+        exclude:
+          # Python 3.6 is not supported beyond Django 3.2
+          - python-version: "3.6"
+            django-version: "4.0"
+          # Python 3.7 is not supported beyond Django 3.2
+          - python-version: "3.7"
+            django-version: "4.0"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Poetry
+        # Need to use version < 1.2.0 in order to support Python 3.6
+        run: pipx install poetry==1.1.15
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: poetry
+
+      - name: Set up dependencies
+        run: |
+          poetry install
+          poetry run pip install "django~=${{ matrix.django-version }}.0"
+
+      - name: Run tests
+        run: poetry run ./runtests
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-20.04
+
+    strategy:
+      matrix:
+        python-version: ["3.6", "3.9"]
+        django-version: ["2.2", "4.0"]
+        exclude:
+          # Python 3.6 is not supported beyond Django 3.2
+          - python-version: "3.6"
+            django-version: "4.0"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Poetry
+        # Need to use version < 1.2.0 in order to support Python 3.6
+        run: pipx install poetry==1.1.15
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: poetry
+
+      - name: Set up dependencies
+        run: |
+          poetry install
+          poetry run pip install "django~=${{ matrix.django-version }}.0"
+
+      - name: Run linters
+        run: poetry run flake8 --jobs=auto --format=github
+
+  type-check:
+    name: Type Check
+    runs-on: ubuntu-20.04
+
+    strategy:
+      matrix:
+        python-version: ["3.6", "3.9"]
+        django-version: ["2.2", "4.0"]
+        exclude:
+          # Python 3.6 is not supported beyond Django 3.2
+          - python-version: "3.6"
+            django-version: "4.0"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Poetry
+        # Need to use version < 1.2.0 in order to support Python 3.6
+        run: pipx install poetry==1.1.15
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: poetry
+
+      - name: Set up dependencies
+        run: |
+          poetry install
+          poetry run pip install "django~=${{ matrix.django-version }}.0"
+
+      - name: Run type checking
+        run: poetry run ./script/type-check

.github/workflows/check.yml

@@ -0,0 +1,41 @@
+name: Create Release & Publish to PYPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  run-checks:
+    uses: ./.github/workflows/check.yml
+
+  publish:
+    runs-on: ubuntu-latest
+    needs:
+      - run-checks
+    steps:
+      # Using v2 or later strips tag annotations https://github.com/actions/checkout/issues/290
+      - uses: actions/checkout@v1
+
+      - name: Set up Poetry
+        # Need to use version < 1.2.0 in order to support Python 3.6
+        run: pipx install poetry==1.1.15
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.7'
+          cache: poetry
+
+      - name: Build
+        run: poetry build
+
+      - name: Publish to PyPI
+        run: |
+          poetry config pypi-token.pypi "${{ secrets.DLQ_PYPI_TOKEN }}"
+          poetry publish
+
+      - name: Create GitHub Release
+        uses: ncipollo/release-action@v1
+        with:
+          body: ${{ steps.tag_data.outputs.git-tag-annotation }}

.github/workflows/publish.yml

@@ -7,15 +7,14 @@ Tests are run with `./runtests`
 ## Releasing
 
 CI handles releasing to PyPI.
-Releases on GitHub are created manually.
+Releases on GitHub are created automatically, using the message from the annotated tag.
 
 Here's how to do a release:
 
  - Get all the desired changes into `master`
  - Wait for CI to pass that
  - Add a bump commit (see previous "Declare vX.Y.Z" commits; `poetry version` may be useful here)
  - Push that commit on master
- - Create a tag of that version number (`git tag v$(poetry version --short)`)
+ - Create a tag of that version number, with a description of the changes in the annotation (`git tag v$(poetry version --short) --annotate`)
  - Push the tag (`git push --tags`)
- - CI will build & deploy that release
- - Create a Release on GitHub, ideally with a summary of changes
+ - CI will build & deploy that release as a GitHub Release and to PyPI