Merge pull request #1029 from VWS-Python/gha-release

Change release process to use GitHub actions

Author: adamtheturtle

.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,59 @@
+---
+
+name: Release
+
+on: workflow_dispatch
+
+jobs:
+  build:
+    name: Publish a release
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ["3.10"]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          # This is like the example but we use ``*requirements.txt`` rather
+          # than ``requirements.txt`` because we have multiple requirements
+          # files.
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/*requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: "Install dependencies"
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          # We use '--ignore-installed' to avoid GitHub's cache which can cause
+          # issues - we have seen packages from this cache cause trouble with
+          # pip-extra-reqs.
+          python -m pip install --ignore-installed --upgrade --editable .[dev]
+
+      - name: "Publish a release"
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        run: |
+          python admin/release.py
+
+      - name: Build a binary wheel and a source tarball
+        run: |
+          # Checkout the latest tag - the one we just created.
+          git fetch --tags
+          git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
+          python -m build --sdist --wheel --outdir dist/ .
+
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          verbose: true

.github/workflows/release.yml

@@ -22,7 +22,6 @@ lint: \
     pip-extra-reqs \
     pip-missing-reqs \
     pyroma \
-    shellcheck \
     spelling \
     vulture \
     pylint \

Makefile

@@ -62,11 +62,10 @@ def main() -> None:
     Perform a release.
     """
     github_token = os.environ['GITHUB_TOKEN']
-    github_owner = os.environ['GITHUB_OWNER']
-    github_repository_name = os.environ['GITHUB_REPOSITORY_NAME']
+    github_repository_name = os.environ['GITHUB_REPOSITORY']
     github_client = Github(github_token)
     github_repository = github_client.get_repo(
-        full_name_or_id=f'{github_owner}/{github_repository_name}',
+        full_name_or_id=github_repository_name,
     )
     version_str = get_version(github_repository=github_repository)
     update_changelog(version=version_str, github_repository=github_repository)

admin/release.py

@@ -7,34 +7,15 @@ Outcomes
 * A new ``git`` tag available to install.
 * A new package on PyPI.
 
-Prerequisites
-~~~~~~~~~~~~~
-
-* ``python3`` on your ``PATH`` set to Python |python-minumum-version|\+.
-* ``virtualenv``.
-* Push access to this repository.
-* Trust that ``master`` is ready and high enough quality for release.
-
 Perform a Release
 ~~~~~~~~~~~~~~~~~
 
-#. Get a GitHub access token:
-
-   Follow the `GitHub access token instructions`_ for getting an access token.
-
-#. Set environment variables to GitHub credentials, e.g.:
-
-    .. prompt:: bash
-
-       export GITHUB_TOKEN=75c72ad718d9c346c13d30ce762f121647b502414
+#. `Install GitHub CLI`_.
 
 #. Perform a release:
 
    .. prompt:: bash
-      :substitutions:
 
-      export GITHUB_OWNER=|github-owner|
-      export GITHUB_REPOSITORY_NAME=|github-repository|
-      curl https://raw.githubusercontent.com/"$GITHUB_OWNER"/"$GITHUB_REPOSITORY_NAME"/master/admin/release.sh | bash
+      $ gh workflow run release.yml
 
-.. _GitHub access token instructions: https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line/
+.. _Install GitHub CLI: https://cli.github.com/manual/installation

admin/release.sh

@@ -68,10 +68,6 @@ linkcheck:
 spelling:
 	$(MAKE) -C docs/ spelling SPHINXOPTS=$(SPHINXOPTS)
 
-.PHONY: shellcheck
-shellcheck:
-	shellcheck --exclude SC2164,SC1091 */*.sh
-
 .PHONY: autoflake
 autoflake:
 	autoflake \