Merge pull request #491 from KhiopsML/347-publish-to-pypi

Publish the python library to TestPyPI and PyPI

Author: tramora

.gitattributes

@@ -1,5 +1,2 @@
 # Commit message template always have Unix endlines
 .git_commit_template eol=lf
-
-# Versioneer
-khiops/_version.py export-subst

.github/workflows/conda.yml

@@ -23,12 +23,8 @@ on:
     tags: ['*']
   pull_request:
     paths:
-      - setup.py
-      - setup.cfg
       - pyproject.toml
       - LICENSE.md
-      - versioneer.py
-      - khiops/_version.py
       - packaging/conda/**,
       - '!packaging/conda/README.md'
       - .github/workflows/conda.yml

.github/workflows/pip.yml

@@ -1,4 +1,7 @@
 ---
+# After building and testing the pip package,
+# this workflow publishes it to Github Release by default
+# and to Test PyPI (TEST) or PyPI (PROD) if requested
 name: Pip Package
 env:
   DEFAULT_SAMPLES_REVISION: 11.0.0
@@ -11,15 +14,13 @@ on:
       image-tag:
         default: 11.0.0-b.0.0
         description: Development Docker Image Tag
+      pypi-target:
+        type: choice
+        default: None  # no publishing to any Package Index by default
+        options: [None, testpypi, pypi]
+        description: Publish to Test PyPI or PyPI
   pull_request:
-    paths:
-      - setup.py
-      - setup.cfg
-      - pyproject.toml
-      - LICENSE.md
-      - versioneer.py
-      - khiops/_version.py
-      - .github/workflows/pip.yml
+    paths: [pyproject.toml, LICENSE.md, .github/workflows/pip.yml]
   push:
     tags: ['*']
 concurrency:
@@ -51,9 +52,9 @@ jobs:
           # Install required Python build dependency
           pip install build
 
-          # Build the package
+          # Build the source package (sdist) only          
           python3 -m build --sdist
-      - name: Upload package as artifact
+      - name: Upload the package as artifact
         uses: actions/upload-artifact@v4
         with:
           name: pip-package
@@ -119,8 +120,12 @@ jobs:
           # The MPI command is not always named mpiexec, but can be orterun etc
           # (as given by khiops_env)
           kh-status | grep "MPI command" | grep -vwq "<empty>"
-  release:
-    if: github.ref_type == 'tag'
+  # The implementation of a unique release job with multiple conditional steps
+  # for each publishing mode is not chosen
+  # because of the required job environment verified for Trusted Publishing
+  release-github:
+    # only publish on tag pushes
+    if: github.ref_type == 'tag' && github.repository_owner == 'KhiopsML'
     needs: [build, test]
     runs-on: ubuntu-22.04
     permissions:
@@ -130,7 +135,7 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: pip-package
-      - name: Upload Pip package to the release
+      - name: Upload Pip source package to the github release
         uses: ncipollo/release-action@v1.15.0
         with:
           allowUpdates: true
@@ -140,3 +145,46 @@ jobs:
           makeLatest: false
           prerelease: true
           updateOnlyUnreleased: true
+  release-testpypi:
+    # only publish on testpypi if requested and on tag pushes
+    if: inputs.pypi-target == 'testpypi' && github.ref_type == 'tag' && github.repository_owner == 'KhiopsML'
+    needs: [build, test]
+    runs-on: ubuntu-22.04
+    permissions:
+      # IMPORTANT: OIDC token mandatory for trusted publishing on TestPyPI and PyPI
+      id-token: write
+    # required job environment verified for Trusted Publishing
+    environment:
+      name: testpypi
+    steps:
+      - name: Download package artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: pip-package
+          path: dist/
+      - name: Publish Python distribution to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+          repository-url: https://test.pypi.org/legacy/
+  release-pypi:
+    # only publish on pypi if requested and on tag pushes
+    if: inputs.pypi-target == 'pypi' && github.ref_type == 'tag' && github.repository_owner == 'KhiopsML'
+    needs: [build, test]
+    runs-on: ubuntu-22.04
+    permissions:
+      # IMPORTANT: OIDC token mandatory for trusted publishing on TestPyPI and PyPI
+      id-token: write
+    # required job environment verified for Trusted Publishing
+    environment:
+      name: pypi
+    steps:
+      - name: Download package artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: pip-package
+          path: dist/
+      - name: Publish Python distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
     hooks:
       - id: pylint
         language_version: python3
-        exclude: doc/convert_samples.py|doc/conf.py|versioneer.py|khiops/_version.py|setup.py
+        exclude: doc/convert_samples.py|doc/conf.py
   - repo: https://github.com/pycqa/isort
     rev: 5.13.2
     hooks: