Merge pull request #73 from JWCook/tag-based-releases

Automate releases based on git tags

Author: melissawm

.github/workflows/release.yml

@@ -0,0 +1,27 @@
+# When a new git tag is pushed:
+# * Build and publish a new release to PyPI
+# * Create new GitHub release with placeholder text linking to changelog
+name: Release
+on:
+  push:
+    tags: ['*']
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+      - name: Build package distributions
+        run: |
+          python -m pip install flit
+          flit build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v1
+        body: "See [changelog](https://github.com/melissawm/sphinx-tags/blob/main/CHANGELOG.md) for release details."

docs/contribute/index.rst

@@ -74,7 +74,10 @@ To cut a new release:
 
 1. Make sure the version string in ``src/sphinx_tags/__init__.py`` is updated
    with the release number you want.
-2. Run ``flit publish`` to upload your new version to PyPI.
-3. Run ``git tag <version>``, and ``git push origin --tags`` to update the tags
+2. Run ``git tag <version>``, and ``git push origin --tags`` to update the tags
    on GitHub.
-4. Make a new release using the GitHub interface.
+3. This will trigger a `GitHub Action <https://github.com/melissawm/sphinx-tags/actions>`__
+   that will build and publish the new release to PyPI. Verify that it completed
+   successfully.
+4. A new `GitHub release <https://github.com/melissawm/sphinx-tags/releases>`__
+   will be created automatically. Update the release description as needed.