Merge pull request #226 from KhiopsML/191-test-khiopspydev-docker-ima…

…ges-before-pushing-them-to-the-registry 191 test khiopspydev docker images before pushing them to the registry
KhiopsML · Aug 23, 2024 · 81a7415 · 81a7415
2 parents 427c1d8 + 36cee90
commit 81a7415
Show file tree

Hide file tree

Showing 8 changed files with 51 additions and 25 deletions.
diff --git a/.github/workflows/api-docs.yml b/.github/workflows/api-docs.yml
@@ -8,6 +8,9 @@ on:
         required: true
         type: boolean
         default: false
+      image-tag:
+        default: latest
+        description: Development Docker Image Tag
   pull_request:
     paths:
       - doc/**.rst
@@ -32,7 +35,11 @@ jobs:
   build:
     runs-on: ubuntu-22.04
     container:
-      image: ghcr.io/khiopsml/khiops-python/khiopspydev-ubuntu22.04:latest
+      # 'latest' default image tag cannot be set as an environment variable,
+      # because the `env` context is only accessible at the step level;
+      # hence, it is hard-coded
+      image: |-
+        ghcr.io/khiopsml/khiops-python/khiopspydev-ubuntu22.04:${{ inputs.image-tag || 'latest' }}
       # Use the 'runner' user (1001) from github so checkout actions work properly
       # https://github.com/actions/runner/issues/2033#issuecomment-1598547465
       options: --user 1001

diff --git a/.github/workflows/dev-docker.yml b/.github/workflows/dev-docker.yml
@@ -2,6 +2,7 @@
 name: Dev Docker
 env:
   DEFAULT_KHIOPS_REVISION: 10.2.2
+  DEFAULT_IMAGE_INCREMENT: 0
   DEFAULT_SERVER_REVISION: main
   DEFAULT_PYTHON_VERSIONS: 3.8 3.9 3.10 3.11 3.12
 on:
@@ -13,13 +14,16 @@ on:
         type: string
         default: main
         description: Khiops Revision
+      image-increment:
+        type: string
+        description: Docker Image Tag Increment
       server-revision:
         type: string
         default: main
         description: Khiops Server Revision
       push:
         type: boolean
-        default: true
+        default: false
         description: Push to GH Registry
       python-versions:
         type: string
@@ -43,8 +47,10 @@ jobs:
         run: |
           set -x
           echo "KHIOPS_REVISION=${{ inputs.khiops-revision || env.DEFAULT_KHIOPS_REVISION }}" >> "$GITHUB_ENV"
+          echo "IMAGE_INCREMENT=${{ inputs.image-increment || env.DEFAULT_IMAGE_INCREMENT }}" >> "$GITHUB_ENV"
           echo "KHIOPSDEV_OS_CODENAME=$(echo '${{ matrix.khiopsdev-os }}' | tr -d '0-9.')" >> "$GITHUB_ENV"
           echo "SERVER_REVISION=${{ inputs.server-revision || env.DEFAULT_SERVER_REVISION }}" >> "$GITHUB_ENV"
+          echo "IMAGE_URL=ghcr.io/khiopsml/khiops-python/khiopspydev-${{ matrix.khiopsdev-os }}" >> "$GITHUB_ENV"
       - name: Checkout khiops-python sources
         uses: actions/checkout@v4
       - name: Set up Docker Buildx
@@ -56,6 +62,15 @@ jobs:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Set up the Docker Image Tags
+        run: |
+          set -x
+          if [[ $GITHUB_REF == '/refs/heads/main' || $GITHUB_REF == '/refs/heads/dev' ]]; then
+            TAGS="$IMAGE_URL:latest,$IMAGE_URL:$KHIOPS_REVISION.$IMAGE_INCREMENT"
+          else
+            TAGS="$IMAGE_URL:$KHIOPS_REVISION.$IMAGE_INCREMENT"
+          fi
+          echo "DOCKER_IMAGE_TAGS=$TAGS" >> "$GITHUB_ENV"
       - name: Build image and push it to GitHub Container Registry
         uses: docker/build-push-action@v5
         with:
@@ -66,24 +81,8 @@ jobs:
             "KHIOPSDEV_OS=${{ matrix.khiopsdev-os }}"
             "SERVER_REVISION=${{ env.SERVER_REVISION }}"
             "PYTHON_VERSIONS=${{ inputs.python-versions || env.DEFAULT_PYTHON_VERSIONS }}"
-          tags: ghcr.io/khiopsml/khiops-python/khiopspydev-${{ matrix.khiopsdev-os }}:latest
+          tags: ${{ env.DOCKER_IMAGE_TAGS }}
           # Push only on manual request
           push: ${{ inputs.push || false }}
       - name: Display the image digest
         run: echo ${{ steps.docker-build.outputs.digest }}
-  test:
-    # Test only when manually pushed an requested
-    if: ${{ inputs.push || false }}
-    needs: build-push
-    runs-on: ubuntu-22.04
-    strategy:
-      fail-fast: false
-      matrix:
-        khiopsdev-os: [ubuntu22.04, rocky8, rocky9]
-    container:
-      image: ghcr.io/khiopsml/khiops-python/khiopspydev-${{ matrix.khiopsdev-os }}:latest
-    steps:
-      - name: Check Khiops executables
-        run: |-
-          khiops -v
-          khiops_coclustering -v
diff --git a/.github/workflows/pip.yml b/.github/workflows/pip.yml
@@ -8,6 +8,9 @@ on:
       samples-revision:
         default: main
         description: khiops-samples repo revision
+      image-tag:
+        default: latest
+        description: Development Docker Image Tag
   pull_request:
   push:
     tags: ['*']
@@ -49,7 +52,11 @@ jobs:
       matrix:
         container: [ubuntu22.04, rocky9]
     container:
-      image: ghcr.io/khiopsml/khiops-python/khiopspydev-${{ matrix.container }}:latest
+      # 'latest' default image tag cannot be set as an environment variable,
+      # because the `env` context is only accessible at the step level;
+      # hence, it is hard-coded
+      image: |-
+        ghcr.io/khiopsml/khiops-python/khiopspydev-${{ matrix.container }}:${{ inputs.image-tag || 'latest' }}
     steps:
       - name: Set parameters as env
         run: |

diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml
@@ -8,6 +8,9 @@ on:
       samples-revision:
         default: main
         description: Git tag, branch or commit for the khiops-samples repository
+      image-tag:
+        default: latest
+        description: Development Docker Image Tag
       run-long-tests:
         type: boolean
         required: false
@@ -25,7 +28,11 @@ jobs:
       matrix:
         python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
     container:
-      image: ghcr.io/khiopsml/khiops-python/khiopspydev-ubuntu22.04:latest
+      # 'latest' default image tag cannot be set as an environment variable,
+      # because the `env` context is only accessible at the step level;
+      # hence, it is hard-coded
+      image: |-
+        ghcr.io/khiopsml/khiops-python/khiopspydev-ubuntu22.04:${{ inputs.image-tag || 'latest' }}
       credentials:
         username: ${{ github.actor }}
         password: ${{ secrets.GITHUB_TOKEN }}
@@ -147,7 +154,11 @@ jobs:
         container: [ubuntu22.04, rocky8, rocky9]
     runs-on: ubuntu-latest
     container:
-      image: ghcr.io/khiopsml/khiops-python/khiopspydev-${{ matrix.container }}:latest
+      # 'latest' default image tag cannot be set as an environment variable,
+      # because the `env` context is only accessible at the step level;
+      # hence, it is hard-coded
+      image: |-
+        ghcr.io/khiopsml/khiops-python/khiopspydev-${{ matrix.container }}:${{ inputs.image-tag || 'latest' }}
       credentials:
         username: ${{ github.actor }}
         password: ${{ secrets.GITHUB_TOKEN }}

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -28,6 +28,8 @@ repos:
     hooks:
       - id: yamlfix
         exclude: packaging/conda/meta.yaml
+        language: python
+        additional_dependencies: [maison<2.0.0]
   - repo: https://github.com/python-jsonschema/check-jsonschema
     rev: 0.29.0
     hooks:

diff --git a/doc/samples/samples_sklearn.rst b/doc/samples/samples_sklearn.rst
@@ -589,7 +589,7 @@ Samples
     print(f"Features evaluated: {khe.n_features_evaluated_}")
     print("Top 3 evaluated features")
     for i, feature in enumerate(khe.feature_evaluated_names_[:3]):
-        print(f"{feature} - Level: {khe.feature_evaluated_importances_[i][0]}")
+        print(f"{feature} - Level: {khe.feature_evaluated_importances_[i]}")
     print("---")
 
     # Transform the train dataset

diff --git a/khiops/samples/samples_sklearn.ipynb b/khiops/samples/samples_sklearn.ipynb
@@ -692,7 +692,7 @@
     "print(f\"Features evaluated: {khe.n_features_evaluated_}\")\n",
     "print(\"Top 3 evaluated features\")\n",
     "for i, feature in enumerate(khe.feature_evaluated_names_[:3]):\n",
-    "    print(f\"{feature} - Level: {khe.feature_evaluated_importances_[i][0]}\")\n",
+    "    print(f\"{feature} - Level: {khe.feature_evaluated_importances_[i]}\")\n",
     "print(\"---\")\n",
     "\n",
     "# Transform the train dataset\n",

diff --git a/khiops/samples/samples_sklearn.py b/khiops/samples/samples_sklearn.py
@@ -609,7 +609,7 @@ def khiops_encoder_multitable_snowflake():
     print(f"Features evaluated: {khe.n_features_evaluated_}")
     print("Top 3 evaluated features")
     for i, feature in enumerate(khe.feature_evaluated_names_[:3]):
-        print(f"{feature} - Level: {khe.feature_evaluated_importances_[i][0]}")
+        print(f"{feature} - Level: {khe.feature_evaluated_importances_[i]}")
     print("---")
 
     # Transform the train dataset