Additional publishing jobs (#1121)

bettinaheim · web-flow · commit 12418a77f185 · 2024-01-23T17:08:57.000+01:00
diff --git a/.github/workflows/docker_images.yml b/.github/workflows/docker_images.yml
@@ -612,6 +612,7 @@ jobs:
     runs-on: ${{ needs.metadata.outputs.runner }}
     permissions:
       contents: read
+      packages: read
 
     steps:
       - name: Checkout repository
@@ -722,6 +723,9 @@ jobs:
     # all jobs that depend on it will need to add the same condition.
     if: always() && !cancelled() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled')
     runs-on: ${{ needs.metadata.outputs.runner }}
+    permissions:
+      contents: read
+      packages: read
 
     steps:
       - name: Checkout repository
@@ -765,7 +769,7 @@ jobs:
           docker cp scripts/validate_container.sh cuda-quantum:"/home/cudaq/validate_container.sh"
           # In containers without GPU support, UCX does not work properly since it is configured to work with GPU-support.
           # Hence, don't enforce UCX when running these tests.
-          (docker exec cuda-quantum bash -c "unset OMPI_MCA_pml && bash validate_container.sh" > /tmp/validation.out) && passed=true || passed=false
+          (docker exec cuda-quantum bash -c "unset OMPI_MCA_pml && bash validate_container.sh" | tee /tmp/validation.out) && passed=true || passed=false
           docker stop cuda-quantum
 
           if ! $passed; then 
diff --git a/.github/workflows/prebuilt_binaries.yml b/.github/workflows/prebuilt_binaries.yml
@@ -174,7 +174,6 @@ jobs:
           context: .
           file: ./docker/release/installer.Dockerfile
           build-args: |
-            release_version=${{ steps.config.outputs.cudaq_version }}
             base_image=${{ steps.config.outputs.image_name }}@${{ steps.docker_build.outputs.digest }}
           platforms: ${{ inputs.platform }}
           outputs: type=local,dest=/tmp/install
@@ -315,7 +314,7 @@ jobs:
       - name: Sanity checks
         run: |
           docker run --rm -dit --name cuda-quantum validation:local
-          (docker exec cuda-quantum bash -l validate.sh > /tmp/validation.out) && passed=true || passed=false
+          (docker exec cuda-quantum bash -l validate.sh | tee /tmp/validation.out) && passed=true || passed=false
           docker stop cuda-quantum
 
           if ! $passed; then 
@@ -433,7 +432,7 @@ jobs:
 
   staging:
     name: Staging
-    needs: [build_installer, validation]
+    needs: [build_installer, build_openmpi, validation]
     if: inputs.environment
     runs-on: ubuntu-latest
     permissions: {}
@@ -452,7 +451,9 @@ jobs:
 
           mkdir -p "$(dirname "$info_file")" && rm -rf "$info_file"
           echo "source-sha: ${{ github.sha }}" >> "$info_file"
-          echo "cuda-quantum-installer-image: $image_hash" >> "$info_file"
+          echo "cuda-quantum-assets-image: $image_hash" >> "$info_file"
+          echo "platform-base-image: ${{ inputs.platform_base_image }}" >> "$info_file"
+          echo "openmpi-build-cache: ${{ needs.build_openmpi.outputs.build_cache }}" >> "$info_file"
           echo "platform: ${{ inputs.platform }}" >> "$info_file"
 
       - name: Upload build info
diff --git a/.github/workflows/publishing.yml b/.github/workflows/publishing.yml
@@ -81,7 +81,7 @@ jobs:
             if [ "${name%_publishing}" != "$name" ]; then
               download "$url" "$name"
               platforms=`cat "$name.txt" | egrep -o 'platforms?: \S*' | cut -d ' ' -f 2`
-              image_hash=`cat "$name.txt" | grep -o -e "cuda-quantum-dev-image: \S*" -e "cuda-quantum-installer-image: \S*" -e "cuda-quantum-wheeldeps-image: \S*" | cut -d ' ' -f 2`
+              image_hash=`cat "$name.txt" | grep -o -e "cuda-quantum-dev-image: \S*" -e "cuda-quantum-assets-image: \S*" -e "cuda-quantum-wheeldeps-image: \S*" | cut -d ' ' -f 2`
               if [ -n "$(echo $platforms | grep ',')" ]; then runner=linux-amd64-cpu8
               else runner=$(echo $platforms | tr / -)-cpu8
               fi
@@ -178,7 +178,7 @@ jobs:
           done
 
           for file in ${{ join(fromJson(steps.artifacts.outputs.installers).info_files, ' ') }}; do
-            create_assets $file cuda-quantum-installer-image cuda-quantum-installer '${{ steps.artifacts.outputs.installers }}'
+            create_assets $file cuda-quantum-assets-image cuda-quantum-assets '${{ steps.artifacts.outputs.installers }}'
           done
 
       - name: Wait for assets
@@ -253,7 +253,6 @@ jobs:
           for file in ${{ join(fromJson(steps.artifacts.outputs.installers).info_files, ' ') }}; do
             download_assets $file '${{ steps.artifacts.outputs.installers }}'
           done
-
         env:
           GH_TOKEN: ${{ secrets.REPO_BOT_ACCESS_TOKEN }}
   
@@ -290,7 +289,19 @@ jobs:
         uses: actions/checkout@v3
         with:
           ref: ${{ needs.assets.outputs.github_commit }}
-          token: ${{ secrets.REPO_BOT_ACCESS_TOKEN }}
+
+      - name: Log in to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_READONLY_TOKEN }}
+
+      - name: Log in to GitHub CR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ github.token }}
 
       - name: Load docker assets
         uses: actions/download-artifact@v4
@@ -339,12 +350,6 @@ jobs:
         env:
           GH_TOKEN: ${{ secrets.REPO_BOT_ACCESS_TOKEN }}
 
-      - name: Log in to DockerHub
-        uses: docker/login-action@v3
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_READONLY_TOKEN }}
-
       - name: Log in to default registry
         if: steps.release_info.outputs.push_to_ngc != 'true'
         uses: docker/login-action@v3
@@ -443,6 +448,111 @@ jobs:
           outputs: |
             image_hash: ${{ steps.release_info.outputs.image_name }}@${{ steps.cudaq_build.outputs.digest }}
 
+  cudaq_installer:
+    name: CUDA Quantum installer
+    if: ${{ toJson(fromJson(needs.assets.outputs.installers).info_files) != '[]' }}
+    needs: assets
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      id-token: write
+
+    environment:
+      name: ghcr-deployment
+      url: ${{ vars.deployment_url }}
+
+    strategy:
+      matrix:
+        info_file: ${{ fromJson(needs.assets.outputs.installers).info_files }}
+      fail-fast: false
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ needs.assets.outputs.github_commit }}
+
+      - name: Load build assets
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ needs.assets.outputs.retrieved_assets }}
+          path: /tmp/assets
+
+      - name: Retrieve assets
+        id: release_info
+        run: |
+          release_id=${{ fromJson(needs.assets.outputs.installers)[format('{0}', matrix.info_file)].release_id }}
+          assets_folder=assets && mkdir "$assets_folder" && cd "$assets_folder"
+          cp -r /tmp/assets/${{ matrix.info_file }}/. "$(pwd)"
+
+          build_info=${{ matrix.info_file }}*
+          platform=`cat $build_info | grep -o 'platform: \S*' | cut -d ' ' -f 2`
+          platform_id=`echo $platform | sed 's/linux\///g' | tr -d ' '`
+          platform_arch=`([ "$platform_id" == "amd64" ] && echo x86_64) || ([ "$platform_id" == "arm64" ] && echo aarch64) || echo any`
+          assets_image=`cat $build_info | grep -o 'cuda-quantum-assets-image: \S*' | cut -d ' ' -f 2`
+          platform_base_image=`cat $build_info | grep -o 'platform-base-image: \S*' | cut -d ' ' -f 2`
+          openmpi_buildcache=`cat $build_info | grep -o 'openmpi-build-cache: \S*' | cut -d ' ' -f 2`
+          for file in `ls *zip`; do unzip "$file" && rm "$file"; done && cd -
+
+          echo "release_id=$release_id" >> $GITHUB_OUTPUT
+          echo "platform=$platform" >> $GITHUB_OUTPUT
+          echo "platform_arch=$platform_arch" >> $GITHUB_OUTPUT
+          echo "assets_image=$assets_image" >> $GITHUB_OUTPUT
+          echo "platform_base_image=$platform_base_image" >> $GITHUB_OUTPUT
+          echo "openmpi_buildcache=$openmpi_buildcache" >> $GITHUB_OUTPUT
+        env:
+          GH_TOKEN: ${{ secrets.REPO_BOT_ACCESS_TOKEN }}
+
+      - name: Log in to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_READONLY_TOKEN }}
+
+      - name: Log in to default registry
+        if: steps.release_info.outputs.push_to_ngc != 'true'
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ vars.registry }}
+          username: ${{ github.actor }}
+          password: ${{ github.token }}
+
+      - name: Set up buildx runner
+        uses: docker/setup-buildx-action@v2
+
+      - name: Build installer
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./docker/release/installer.Dockerfile
+          build-args: |
+            base_image=${{ steps.release_info.outputs.assets_image }}
+            additional_components=assets
+          platforms: ${{ steps.release_info.outputs.platform }}
+          outputs: type=local,dest=/tmp/install
+
+      - name: Update release information
+        run: |
+          release_id=${{ steps.release_info.outputs.release_id }}
+          gh release view $release_id --json body --jq .body > rel_notes.txt
+          header_length=`cat rel_notes.txt | grep -n "Release notes generated" | cut -d ':' -f 1`
+          head -n $(($header_length - 1)) rel_notes.txt > new_notes.txt
+          echo -e "\nImage to create ${{ steps.release_info.outputs.platform }} installer:\n" >> new_notes.txt
+          echo "- cuda-quantum-assets: ${{ steps.release_info.outputs.assets_image }}" >> new_notes.txt
+          (echo && tail -n +$header_length rel_notes.txt) >> new_notes.txt
+          gh release edit $release_id -R ${{ github.repository }} --notes-file new_notes.txt
+        env:
+          GH_TOKEN: ${{ secrets.REPO_BOT_ACCESS_TOKEN }}
+
+      - name: Upload installer
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ steps.release_info.outputs.platform_arch }}-installer
+          path: /tmp/install
+          retention-days: 1
+          if-no-files-found: error
+
   cudaq_wheels:
     name: CUDA Quantum Python wheels
     if: ${{ toJson(fromJson(needs.assets.outputs.python_wheels).info_files) != '[]' }}
@@ -467,7 +577,6 @@ jobs:
         uses: actions/checkout@v3
         with:
           ref: ${{ needs.assets.outputs.github_commit }}
-          token: ${{ secrets.REPO_BOT_ACCESS_TOKEN }}
 
       - name: Load wheel assets
         uses: actions/download-artifact@v4
@@ -528,7 +637,7 @@ jobs:
       - name: Upload wheels
         uses: actions/upload-artifact@v4
         with:
-          name: ${{ steps.release_info.outputs.platform_arch }}-wheels
+          name: ${{ steps.release_info.outputs.platform_arch }}-py${{ matrix.python_version }}-wheels
           path: /tmp/wheels
           retention-days: 1
           if-no-files-found: error
@@ -561,7 +670,7 @@ jobs:
 
   config:
     name: Configure validation
-    needs: [cudaq_hpc, cudaq_wheels]
+    needs: [cudaq_hpc, cudaq_installer, cudaq_wheels]
     runs-on: ubuntu-latest
 
     outputs:
@@ -580,11 +689,67 @@ jobs:
           images=`echo '${{ steps.read_json.outputs.result }}' | jq '[.image_hash[] | select(. != "")]'`
           echo "docker_images=$(echo $images)" >> $GITHUB_OUTPUT
 
-  validation:
-    name: Validation
-    needs: [assets, config]
+  installer_validation:
+    name: Installer validation
+    needs: [assets, cudaq_installer]
     runs-on: linux-amd64-gpu-v100-latest-1
 
+    container:
+      image: redhat/ubi8:8.0
+      options: --user root
+      env:
+        NVIDIA_VISIBLE_DEVICES: ${{ env.NVIDIA_VISIBLE_DEVICES }}
+        TERM: xterm
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ needs.assets.outputs.github_commit }}
+
+      - name: Load installer
+        uses: actions/download-artifact@v4
+        with:
+          name: x86_64-installer
+          path: /tmp/install
+
+      - name: Install runtime dependencies
+        run: |
+          dnf install -y --nobest --setopt=install_weak_deps=False \
+            'dnf-command(config-manager)' gcc-toolset-12
+          enable_script=`find / -path '*gcc*' -path '*12*' -name enable`
+          . "$enable_script"
+          . scripts/configure_build.sh install-cudart
+
+      # TODO: Add nvidia-mgpu to the arguments for validate_container.sh
+      # (Currently missing an rpath, since it is not finding libcustatevec.so.1)
+      - name: Install and run sanity checks
+        shell: bash
+        run: |
+          chmod +x /tmp/install/install_cuda_quantum.*
+          /tmp/install/install_cuda_quantum.* --accept
+          rm -rf examples && mv docs/sphinx/examples examples && rm -rf examples/python
+          bash -l scripts/validate_container.sh nvidia tensornet | tee /tmp/validation.out
+
+      - name: Create summary
+        if: always() && !cancelled()
+        run: |
+          if [ -f /tmp/validation.out ]; then
+            echo "## Validation" >> $GITHUB_STEP_SUMMARY
+            echo "The validation of the CUDA Quantum installation produced the following output:" >> $GITHUB_STEP_SUMMARY
+            echo '```text' >> $GITHUB_STEP_SUMMARY
+            cat /tmp/validation.out >> $GITHUB_STEP_SUMMARY
+            echo '```' >> $GITHUB_STEP_SUMMARY
+          fi
+
+  image_validation:
+    name: Docker image validation
+    needs: config
+    runs-on: linux-amd64-gpu-v100-latest-1
+    permissions:
+      contents: read
+      packages: read
+
     strategy:
       matrix:
         image_hash: ${{ fromJson(needs.config.outputs.docker_images) }}
@@ -671,7 +836,7 @@ jobs:
 
   create_release:
     name: CUDA Quantum Release
-    needs: [assets, cudaq_hpc, cudaq_wheels, validation]
+    needs: [assets, cudaq_hpc, cudaq_wheels, image_validation]
     if: needs.assets.outputs.release_title
     runs-on: ubuntu-latest
 
@@ -721,7 +886,7 @@ jobs:
 
   clean_up:
     name: Clean up
-    needs: [assets, cudaq_hpc, cudaq_wheels, create_release, validation]
+    needs: [assets, cudaq_hpc, cudaq_wheels, create_release, image_validation]
     # Force this job to run even when some of the dependencies above are skipped.
     if: always() && !cancelled() && needs.assets.result != 'skipped' && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled')
     runs-on: ubuntu-latest
diff --git a/docker/release/cudaq.ext.Dockerfile b/docker/release/cudaq.ext.Dockerfile
@@ -31,7 +31,7 @@ RUN apt-get install -y --no-install-recommends \
         # just here for convenience:
         curl jq 
 RUN if [ -x "$(command -v pip)" ]; then \
-        apt-get install -y --no-install-recommends gcc \
+        apt-get install -y --no-install-recommends gcc libpython3-dev \
         && pip install --no-cache-dir jupyterlab matplotlib; \
         if [ -n "$MPI_ROOT" ]; then \
             pip install --no-cache-dir mpi4py~=3.1; \
diff --git a/docker/release/installer.Dockerfile b/docker/release/installer.Dockerfile
@@ -18,9 +18,9 @@ ARG base_image=ghcr.io/nvidia/cuda-quantum-assets:amd64-gcc11-main
 ARG additional_components=none
 
 FROM $base_image as additional_components_none
-ONBUILD RUN echo "No additional components included."
+RUN echo "No additional components included."
 FROM $base_image as additional_components_assets
-ONBUILD COPY assets /assets
+COPY assets /assets/
 RUN source /cuda-quantum/scripts/configure_build.sh && \
     for folder in `find /assets/*$(uname -m)/* -maxdepth 0 -type d`; \
     do bash /cuda-quantum/scripts/migrate_assets.sh -s "$folder" && rm -rf "$folder"; \
