Merge pull request #1028 from VWS-Python/gha-pypi-release

Switch to GitHub actions for releasing to PyPI

Author: adamtheturtle

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

@@ -0,0 +1,44 @@
+---
+
+name: Publish Python distributions to PyPI
+
+on: push
+
+jobs:
+  build:
+    name: Publish Python distributions to PyPI
+    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 }}
+
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+          .
+
+      - name: Publish distribution 📦 to PyPI
+        if: startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          verbose: true

admin/release.py

@@ -4,7 +4,6 @@
 
 import datetime
 import os
-import subprocess
 from pathlib import Path
 
 from github import Github
@@ -58,21 +57,6 @@ def update_changelog(version: str, github_repository: Repository) -> None:
     )
 
 
-def build_and_upload_to_pypi() -> None:
-    """
-    Build source and binary distributions.
-    """
-    for args in (
-        ['git', 'fetch', '--tags'],
-        ['git', 'merge', 'origin/master'],
-        ['rm', '-rf', 'build'],
-        ['git', 'status'],
-        ['python', 'setup.py', 'sdist', 'bdist_wheel'],
-        ['twine', 'upload', '-r', 'pypi', 'dist/*'],
-    ):
-        subprocess.run(args=args, check=True)
-
-
 def main() -> None:
     """
     Perform a release.
@@ -94,7 +78,6 @@ def main() -> None:
         type='commit',
         object=github_repository.get_commits()[0].sha,
     )
-    build_and_upload_to_pypi()
 
 
 if __name__ == '__main__':

docs/source/release-process.rst

@@ -18,39 +18,6 @@ Prerequisites
 Perform a Release
 ~~~~~~~~~~~~~~~~~
 
-#. Install keyring
-
-   Make sure that `keyring <https://pypi.org/project/keyring/>`__ is available on your path.
-
-   E.g.:
-
-   .. prompt:: bash
-
-      python3 -m pip install --user pipx
-      python3 -m pipx ensurepath
-      pipx install keyring
-
-#. Set up PyPI credentials
-
-Register at `PyPI <https://pypi.org>`__.
-
-Add the following information to :file:`~/.pypirc`.
-
-.. code:: ini
-
-   [distutils]
-    index-servers=
-        pypi
-
-    [pypi]
-    username = <Your PyPI username>
-
-Store your PyPI password:
-
-.. prompt:: bash
-
-   keyring set https://upload.pypi.org/legacy/ <Your PyPI username>
-
 #. Get a GitHub access token:
 
    Follow the `GitHub access token instructions`_ for getting an access token.

pyproject.toml

@@ -181,6 +181,9 @@ ignore_path = [
     "./src/*/_setuptools_scm_version.txt",
 ]
 
+[tool.setuptools_scm]
+
+
 [tool.pydocstyle]
 # We do not have summary lines, care about "mood", or need sections with
 # dash underlined titles.

requirements/dev-requirements.txt

@@ -30,7 +30,6 @@ sphinx-autodoc-typehints==1.12.0
 sphinx_paramlinks==0.5.2
 sphinxcontrib-httpdomain==1.8.0
 sphinxcontrib-spelling==7.3.0
-twine==3.7.1
 types-Flask==1.1.6
 types-freezegun==1.1.3
 types-PyYAML==6.0.1

setup.py

@@ -35,7 +35,7 @@ def _get_dependencies(requirements_file: Path) -> list[str]:
     # We use a dictionary with a fallback version rather than "True"
     # like https://github.com/pypa/setuptools_scm/issues/77 so that we do not
     # error in Docker.
-    use_scm_version={'fallback_version': 'FALLBACK_VERSION'},
+    # use_scm_version={'fallback_version': 'FALLBACK_VERSION'},
     setup_requires=SETUP_REQUIRES,
     install_requires=INSTALL_REQUIRES,
     extras_require={'dev': DEV_REQUIRES},