improving GitHub publish workflow

Author: ropeless

.github/workflows/python-publish.yml

@@ -44,8 +44,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        # os: [ubuntu-latest, windows-latest, macos-13, macos-14]
-        os: [windows-latest, macos-13]
+        os: [ubuntu-latest, windows-latest, macos-13, macos-14]
 
     steps:
       - uses: actions/checkout@v4
@@ -61,31 +60,31 @@ jobs:
           name: dist-wheels-${{ matrix.os }}-${{ strategy.job-index }}
           path: dist/*.whl
 
-#  pypi-publish:
-#    runs-on: ubuntu-latest
-#    needs:
-#      - release-build-sdist
-#      - release-build-wheels
-#    permissions:
-#      # IMPORTANT: this permission is mandatory for trusted publishing
-#      id-token: write
-#
-#    environment:
-#      name: pypi
-#      url: https://pypi.org/p/compiled-knowledge
-#
-#    steps:
-#      - name: Retrieve release distributions
-#        uses: actions/download-artifact@v4
-#        with:
-#          pattern: dist-*
-#          path: dist/
-#          merge-multiple: true
-#
-#      - name: Publish release distributions to PyPI
-#        uses: pypa/gh-action-pypi-publish@release/v1
-#        with:
-#          packages-dir: dist/
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build-sdist
+      - release-build-wheels
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/compiled-knowledge
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          pattern: dist-*
+          path: dist/
+          merge-multiple: true
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
 
   testpypi-publish:
     runs-on: ubuntu-latest

RELEASING.md

@@ -15,15 +15,27 @@ Prepare for the release
 
 Only proceed if the "main" branch is ready for release.
 
-Perform the release
--------------------
+Perform the release - GitHub action
+-----------------------------------
+
+1. Commit and push the "main" branch.
+   This will automatically release the documentation.
+2. Go to the project [GitHub Actions, Upload Python Package](https://github.com/ropeless/compiled_knowledge/actions/workflows/python-publish.yml).
+3. Select "Run workflow".
+
+Perform the release - manual
+----------------------------
+
+This manual release process will only upload wheels for the platform that
+these commands are run on. 
 
 1. Commit and push the "main" branch.
    This will automatically release the documentation.
 2. Ensure you are on an up-to-date checkout of the "main" branch.
 3. Delete any existing project `dist` directory.
-4. Build the package using: `python setup.py sdist bdist_wheel`.
-5. Upload the package to PyPI using: `python -m twine upload dist/*`.
+4. Build the source distribution using: `python setup.py sdist`.
+5. Build the binary distribution using: `cibuildwheel --output-dir dist`.
+6. Upload the package to PyPI using: `python -m twine upload dist/*`.
 
 
 Post-release checks

docs/1_introduction.ipynb

@@ -64,6 +64,7 @@
     "* toml,\n",
     "* setuptools,\n",
     "* build,\n",
+    "* cibuildwheel,\n",
     "* twine,\n",
     "* coverage.\n",
     "\n",