Improve CI workflow (#113)

* Deploy and tag via an action
* Create package once and test over many environments
* Create a GitHub release on deploy

Author: nicoddemus

.github/workflows/deploy.yml

@@ -1,32 +1,52 @@
 name: deploy
 
 on:
-  push:
-    tags:
-      - "v*"
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Release version'
+        required: true
+        default: '1.2.3'
+
 jobs:
+
+  package:
+    runs-on: ubuntu-latest
+    env:
+      SETUPTOOLS_SCM_PRETEND_VERSION: ${{ github.event.inputs.version }}
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Build and Check Package
+      uses: hynek/build-and-inspect-python-package@v1.5
+
   deploy:
+    needs: package
     runs-on: ubuntu-latest
+    environment: deploy
+    permissions:
+      id-token: write  # For PyPI trusted publishers.
+      contents: write  # For tag and release notes.
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
 
-    - name: Set up Python
-      uses: actions/setup-python@v1
+    - name: Download Package
+      uses: actions/download-artifact@v3
       with:
-        python-version: "3.9"
+        name: Packages
+        path: dist
 
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install build
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@v1.8.5
 
-    - name: Build package
+    - name: Push tag
       run: |
-        python -m build
+        git config user.name "pytest bot"
+        git config user.email "pytestbot@gmail.com"
+        git tag --annotate --message=v${{ github.event.inputs.version }} v${{ github.event.inputs.version }} ${{ github.sha }}
+        git push origin v${{ github.event.inputs.version }}
 
-    - name: Publish package to PyPI
-      uses: pypa/gh-action-pypi-publish@master
-      with:
-        user: __token__
-        password: ${{ secrets.pypi_token }}
+    - name: GitHub Release
+      uses: softprops/action-gh-release@v1

.github/workflows/test.yml

@@ -6,6 +6,10 @@ on:
       - "*"
   pull_request:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   compile:
 
@@ -53,8 +57,15 @@ jobs:
             !tests/**/*.xml
             !tests/**/*.o
 
+  package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build and Check Package
+        uses: hynek/build-and-inspect-python-package@v1.5
+
   test:
-    needs: compile
+    needs: [compile, package]
     runs-on: ubuntu-latest
 
     strategy:
@@ -79,15 +90,25 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python }}
+
     - name: Download compiled tests
-      uses: actions/download-artifact@v2
+      uses: actions/download-artifact@v3
       with:
         name: tests
         path: tests
+
+    - name: Download Package
+      uses: actions/download-artifact@v3
+      with:
+        name: Packages
+        path: dist
+
     - name: Install Tox
       run: |
         chmod a+x -R tests
         pip install tox
+
     - name: Test
+      shell: bash
       run: |
-        tox -e ${{ matrix.tox_env }}
+        tox run -e ${{ matrix.tox_env }} --installpkg `find dist/*.tar.gz`

RELEASING.rst

@@ -0,0 +1,7 @@
+Here are the steps on how to make a new release.
+
+1. Create a ``release-VERSION`` branch from ``upstream/main``.
+2. Update ``CHANGELOG.rst``.
+3. Push the branch to ``upstream``.
+4. Once all tests pass, start the ``deploy`` workflow manually.
+5. Merge the PR.

setup.py

@@ -19,6 +19,7 @@
     author_email="nicoddemus@gmail.com",
     description="Use pytest's runner to discover and execute C++ tests",
     long_description=open("README.rst").read(),
+    long_description_content_type="text/x-rst",
     license="MIT",
     keywords="pytest test unittest",
     url="http://github.com/pytest-dev/pytest-cpp",