merge #83 into openSUSE/libpathrs:main

Aleksa Sarai (5):
  gha: python: automate PyPI release of python bindings
  gha: run workflows on tag pushes
  gha: python: split build from smoke-tests
  gha: python: run twine check
  gha: python: test more versions

LGTMs: cyphar

Author: cyphar

.github/workflows/bindings-c.yml

@@ -17,6 +17,8 @@
 on:
   push:
     branches: [ main ]
+    tags:
+      - 'v*'
   pull_request:
     branches: [ main ]
   release:

.github/workflows/bindings-go.yml

@@ -17,6 +17,8 @@
 on:
   push:
     branches: [ main ]
+    tags:
+      - 'v*'
   pull_request:
     branches: [ main ]
   release:

.github/workflows/bindings-python.yml

@@ -17,13 +17,18 @@
 on:
   push:
     branches: [ main ]
+    tags:
+      - 'v*'
   pull_request:
     branches: [ main ]
   release:
     types: [ published ]
   schedule:
     - cron: '0 0 * * *'
 
+env:
+  PYTHON_DIST: ${{ github.workspace }}/.tmp/python3-pathrs-${{ github.run_id }}-${{ github.run_attempt }}
+
 name: bindings-python
 
 jobs:
@@ -66,11 +71,11 @@ jobs:
           workdir: contrib/bindings/python/pathrs
           fail_on_error: true
 
-  smoke-test:
+  build-pyproject:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.10", "3.12"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.x"]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -86,11 +91,12 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: install pypa/build
         run: >-
-          python3 -m pip install --user build
+          python3 -m pip install --user build twine
       # Build and install our bindings.
-      - name: build python-libpathrs bindings
+      - name: build python-pathrs bindings
         run: make -C contrib/bindings/python dist
-      - name: install python-libpathrs bindings
+      - run: twine check contrib/bindings/python/dist/*
+      - name: install python-pathrs bindings
         run: make -C contrib/bindings/python install
       # Verify that the crate and python bindings have the same version.
       # TODO: Move this to a "make check" we can run locally as well.
@@ -104,19 +110,79 @@ jobs:
 
           [[ "$CRATE_VERSION" == "$PY_VERSION" ]] || exit 1
       # Include the dist/ in our artefacts.
-      - name: upload python-libpathrs bindings dist/
+      - name: upload python-pathrs bindings dist/
         uses: actions/upload-artifact@v4
         with:
-          name: python-${{ matrix.python-version }}-libpathrs-dist
+          name: python-${{ matrix.python-version }}-pathrs-dist
           path: contrib/bindings/python/dist/
+
+  smoke-test:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.x"]
+    needs:
+      - build-pyproject
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      # Build and install libpathrs.so.
+      - uses: dtolnay/rust-toolchain@stable
+      - name: build libpathrs
+        run: make release
+      - name: install libpathrs
+        run: sudo ./install.sh --libdir=/usr/lib
+      # Set up python venv.
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      # Download the pre-built python dist.
+      - name: download built python-pathrs
+        uses: actions/download-artifact@v4
+        with:
+          name: python-${{ matrix.python-version }}-pathrs-dist
+          path: ${{ env.PYTHON_DIST }}
+      - name: install python-pathrs
+        run: |-
+          python3 -m pip install ${{ env.PYTHON_DIST }}/*.whl
       # Run smoke-tests.
       - run: make -C examples/python smoke-test
 
+  # TODO: Should we move this to a separate workflow?
+  release-pypi:
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    needs:
+      - build-pyproject
+    runs-on: ubuntu-latest
+    environment:
+      name: release-pypi
+      url: "https://pypi.org/p/pathrs"
+    permissions:
+      id-token: write
+    steps:
+      - name: download built python-pathrs
+        uses: actions/download-artifact@v4
+        with:
+          name: python-3.x-pathrs-dist
+          path: ${{ env.PYTHON_DIST }}
+      # PyPI doesn't let us upload our native wheel because we aren't building
+      # using the restrictive manylinux set of libraries (because we depend on
+      # libpathrs.so).
+      - name: remove wheel from python-pathrs
+        run: rm -fv ${{ env.PYTHON_DIST }}/*.whl
+      - name: upload python-pathrs to pypi
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: ${{ env.PYTHON_DIST }}
+
   complete:
+    if: ${{ ! failure() && ! cancelled() }}
     needs:
       - black
       - mypy
+      - build-pyproject
       - smoke-test
+      - release-pypi
     runs-on: ubuntu-latest
     steps:
       - run: echo "Python CI jobs completed successfully."

.github/workflows/rust.yml

@@ -17,6 +17,8 @@
 on:
   push:
     branches: [ main ]
+    tags:
+      - 'v*'
   pull_request:
     branches: [ main ]
   release: