ci: Use the new image name for version >=26.1 (#4291)

Use the image from `ghcr.io/ansys/fluent` for 26.1 development and CI
runs.

---------

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: mkundu1

.ci/pull_fluent_image.py

@@ -0,0 +1,24 @@
+"""
+Pull a Fluent Docker image based on the FLUENT_IMAGE_TAG environment variable.
+"""
+
+import os
+import subprocess
+
+from ansys.fluent.core.docker.utils import get_ghcr_fluent_image_name
+
+
+def pull_fluent_image():
+    """Pull Fluent Docker image and clean up dangling images."""
+    fluent_image_tag = os.getenv("FLUENT_IMAGE_TAG", "latest")
+    image_name = (
+        f"ghcr.io/ansys/fluent@{fluent_image_tag}"
+        if fluent_image_tag.startswith("sha256")
+        else f"{get_ghcr_fluent_image_name(fluent_image_tag)}:{fluent_image_tag}"
+    )
+    subprocess.run(["docker", "pull", image_name], check=True)
+    subprocess.run(["docker", "image", "prune", "-f"], check=True)
+
+
+if __name__ == "__main__":
+    pull_fluent_image()

.ci/pull_fluent_image.sh

@@ -22,7 +22,7 @@ permissions:
   issues: write
 
 env:
-  API_CODE_CACHE: 4
+  API_CODE_CACHE: 5
   DOCUMENTATION_CNAME: "fluent.docs.pyansys.com"
   PACKAGE_NAME: "ansys-fluent-core"
   PACKAGE_NAMESPACE: "ansys.fluent.core"
@@ -429,13 +429,17 @@ jobs:
         if: steps.cache-api-code.outputs.cache-hit != 'true'
         run: make docker-pull
         env:
-          FLUENT_IMAGE_TAG: ${{ vars.FLUENT_STABLE_IMAGE_DEV }}
+          # FLUENT_IMAGE_TAG: ${{ vars.FLUENT_STABLE_IMAGE_DEV }}
+          # Temporary until the stable image tag is update for the new image path
+          FLUENT_IMAGE_TAG: v26.1.latest
 
       - name: Run 26.1 API codegen
         if: steps.cache-api-code.outputs.cache-hit != 'true'
         run: make api-codegen
         env:
-          FLUENT_IMAGE_TAG: ${{ vars.FLUENT_STABLE_IMAGE_DEV }}
+          # FLUENT_IMAGE_TAG: ${{ vars.FLUENT_STABLE_IMAGE_DEV }}
+          # Temporary until the stable image tag is update for the new image path
+          FLUENT_IMAGE_TAG: v26.1.latest
 
       - name: Print 26.1 Fluent version info
         run: |
@@ -486,11 +490,13 @@ jobs:
             version: 251
           - image-tag: v25.2.0
             version: 252
-          - image-tag: v26.1.0
+          - image-tag: v26.1.latest
             version: 261
     timeout-minutes: 60
     env:
-      FLUENT_IMAGE_TAG: ${{ matrix.version == 261 && vars.FLUENT_STABLE_IMAGE_DEV || matrix.image-tag }}
+      # FLUENT_IMAGE_TAG: ${{ matrix.version == 261 && vars.FLUENT_STABLE_IMAGE_DEV || matrix.image-tag }}
+      # Temporary until the stable image tag is update for the new image path
+      FLUENT_IMAGE_TAG: ${{ matrix.image-tag }}
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/ci.yml

@@ -50,7 +50,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.ADMIN_ACCESS_TOKEN }}
         if: github.ref == 'refs/heads/main'
         run: |
-          DIGEST=$(docker inspect --format='{{index .RepoDigests 0}}' ghcr.io/ansys/pyfluent:${{ env.FLUENT_IMAGE_TAG }} | sed 's/.*@//')
+          DIGEST=$(docker inspect --format='{{index .RepoDigests 0}}' ghcr.io/ansys/fluent:${{ env.FLUENT_IMAGE_TAG }} | sed 's/.*@//')
           gh variable set FLUENT_STABLE_IMAGE_DEV --body $DIGEST
 
       - name: Remove all docker images

.github/workflows/force-update-stable-Fluent-image-version.yml

@@ -99,7 +99,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.ADMIN_ACCESS_TOKEN }}
         if: github.ref == 'refs/heads/main'
         run: |
-          DIGEST=$(docker inspect --format='{{index .RepoDigests 0}}' ghcr.io/ansys/pyfluent:${{ env.FLUENT_IMAGE_TAG }} | sed 's/.*@//')
+          DIGEST=$(docker inspect --format='{{index .RepoDigests 0}}' ghcr.io/ansys/fluent:${{ env.FLUENT_IMAGE_TAG }} | sed 's/.*@//')
           gh variable set FLUENT_STABLE_IMAGE_DEV --body $DIGEST
 
       - name: Remove all docker images

.github/workflows/test-run-dev-version-nightly.yml

@@ -20,7 +20,7 @@ version-info:
 	@bash -c "git --no-pager log -n 1 --format='%h' | xargs -I hash sed -i 's/<id>/hash/g' src/ansys/fluent/core/__init__.py"
 
 docker-pull:
-	@bash .ci/pull_fluent_image.sh
+	@python .ci/pull_fluent_image.py
 
 docker-clean-images:
 	@docker system prune --volumes -a -f

Makefile

@@ -0,0 +1 @@
+Use the new image name for version >=26.1

doc/changelog.d/4291.maintenance.md

@@ -52,6 +52,7 @@
 from ansys.fluent.core import FluentMode, launch_fluent
 from ansys.fluent.core.codegen import StaticInfoType
 from ansys.fluent.core.codegen.data.fluent_gui_help_patch import XML_HELP_PATCH
+from ansys.fluent.core.docker.utils import get_ghcr_fluent_image_name
 from ansys.fluent.core.services.datamodel_tui import (
     convert_path_to_grpc_path,
     convert_tui_menu_to_func_name,
@@ -97,7 +98,7 @@ def _get_tui_docdir(mode: str):
 def _copy_tui_help_xml_file(version: str):
     if os.getenv("PYFLUENT_LAUNCH_CONTAINER") == "1":
         image_tag = os.getenv("FLUENT_IMAGE_TAG", "v25.1.0")
-        image_name = f"ghcr.io/ansys/pyfluent:{image_tag}"
+        image_name = f"{get_ghcr_fluent_image_name(image_tag)}:{image_tag}"
         container_name = uuid.uuid4().hex
         is_linux = platform.system() == "Linux"
         subprocess.run(

src/ansys/fluent/core/codegen/tuigen.py

@@ -26,16 +26,19 @@
 import subprocess
 import uuid
 
+from .utils import get_ghcr_fluent_image_name
+
 
 class ComposeBasedLauncher:
     """Launch Fluent through docker or Podman compose."""
 
     def __init__(self, *, container_dict):
         self._compose_name = f"pyfluent_compose_{uuid.uuid4().hex}"
         self._container_dict = container_dict
+        image_tag = os.getenv("FLUENT_IMAGE_TAG")
         self._image_name = (
             container_dict.get("fluent_image")
-            or f"ghcr.io/ansys/pyfluent:{os.getenv('FLUENT_IMAGE_TAG')}"
+            or f"{get_ghcr_fluent_image_name(image_tag)}:{image_tag}"
         )
         self._container_source = self._set_compose_cmds()
         self._container_source.remove("compose")

src/ansys/fluent/core/docker/docker_compose.py

@@ -0,0 +1,35 @@
+# Copyright (C) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""
+Utility functions for working with Fluent Docker images.
+"""
+
+
+def get_ghcr_fluent_image_name(image_tag: str):
+    """
+    Get the Fluent image name from GitHub registry based on the image tag.
+    """
+    if image_tag >= "v26.1":
+        return "ghcr.io/ansys/fluent"
+    else:
+        return "ghcr.io/ansys/pyfluent"