Merge workflow to have only one for each platform (#839)

Merge release and build workflows. Now only one workflow where _userguide_ and _release_ jobs are called only on release event - Remove "xpress" qualifier from assets - Properly use vcpkg and cache its cache. No more manual installed. Install is done at configure time. - Build job always generate assets. Avoid requiring a release run to test assets --------- Co-authored-by: abdoulbari zaher <[email protected]>
AntaresSimulatorTeam · Jun 12, 2024 · b4020a0 · b4020a0
1 parent 35303e4
commit b4020a0
Show file tree

Hide file tree

Showing 13 changed files with 579 additions and 1,248 deletions.
diff --git a/.github/workflows/build_centos7.yml b/.github/workflows/build_centos7.yml
@@ -89,6 +89,10 @@ jobs:
       XPRS_LIB_Path_CONTAINER: ${GITHUB_WORKSPACE}/xpress/lib
       VCPKG_ROOT: ${{ github.workspace }}/vcpkg
 
+    outputs:
+      TGZ_NAME: ${{ steps.export_output.outputs.TGZ_NAME }}
+      SINGLE_FILE_NAME: ${{ steps.export_output.outputs.SINGLE_FILE_NAME }}
+
     steps:
       - run: |
           source /opt/rh/devtoolset-10/enable
@@ -128,23 +132,6 @@ jobs:
           ref: ${{matrix.xprs.ref}}
         if: matrix.xprs.value == 'XPRESS-ON'
 
-      - name: Restore vcpkg and its artifacts.
-        uses: actions/cache@v3
-        with:
-          # The first path is the location of vcpkg (it contains the vcpkg executable and data files).
-          # The other paths starting with '!' are exclusions: they contain termporary files generated during the build of the installed packages.
-          path: |
-            ${{ env.VCPKG_ROOT }}
-            !${{ env.VCPKG_ROOT }}/buildtrees
-            !${{ env.VCPKG_ROOT }}/packages
-            !${{ env.VCPKG_ROOT }}/downloads
-          # The key is composed in a way that it gets properly invalidated: this must happen whenever vcpkg's Git commit id changes, or the list of packages changes. In this case a cache miss must happen and a new entry with a new key with be pushed to GitHub the cache service.
-          # The key includes: hash of the vcpkg.json file, the hash of the vcpkg Git commit id, and the used vcpkg's triplet. The vcpkg's commit id would suffice, but computing an hash out it does not harm.
-          # Note: given a key, the cache content is immutable. If a cache entry has been created improperly, in order the recreate the right content the key must be changed as well, and it must be brand new (i.e. not existing already).
-          key: |
-            ${{ hashFiles( 'vcpkg.json' ) }}-${{ hashFiles( '.git/modules/vcpkg/HEAD' )}}-${{ matrix.triplet }}
-
-
       - name: Download pre-compiled librairies
         uses: ./.github/workflows/download-extract-precompiled-libraries-tgz
         with:
@@ -163,38 +150,158 @@ jobs:
           pip3 install -r requirements-tests.txt
           pip3 install -r requirements-ui.txt
 
+      - run: |
+          mkdir -p ${{ github.workspace }}/vcpkg_cache
+
       - name: vcpkg install
         run: |
           pushd vcpkg
           git fetch --unshallow
-          ./bootstrap-vcpkg.sh
-          popd
-          vcpkg/vcpkg install
+          ./bootstrap-vcpkg.sh --disableMetrics
+
+      - name: Restore vcpkg binary dir from cache
+        id: cache-vcpkg-binary
+        uses: actions/cache/restore@v3
+        with:
+          path: ${{ github.workspace }}/vcpkg_cache
+          key: vcpkg-cache-centOS-${{ hashFiles('src/vcpkg.json', '.git/modules/vcpkg/HEAD') }}
+          # Allows to restore a cache when deps have only partially changed (like adding a dependency)
+          restore-keys: vcpkg-cache-centOS-
 
       - name: Configure
         run: |
-          [[ ${{ matrix.xprs.value }} == "XPRESS-ON" ]] && XPRESS_VALUE="ON" || XPRESS_VALUE="OFF" 
           source /opt/rh/devtoolset-10/enable
           cmake -B _build -S . \
                  -DDEPS_INSTALL_DIR=rte-antares-deps-Release \
                  -DBUILD_TESTING=ON \
                  -DCMAKE_BUILD_TYPE=Release \
                  -DCMAKE_INSTALL_PREFIX=_install \
                  -DBUILD_UI=ON \
-                 -DXPRESS=${{ env.XPRESS_VALUE }} \
                  -DALLOW_RUN_AS_ROOT=ON \
                  -DCMAKE_TOOLCHAIN_FILE=vcpkg/scripts/buildsystems/vcpkg.cmake
 
       - name: Build
         run: |
           cmake --build _build --config Release -j$(nproc)
 
+      - name: Cache vcpkg binary dir
+        if: always()
+        id: save-cache-vcpkg-binary
+        uses: actions/cache/save@v3
+        with:
+          path: ${{ github.workspace }}/vcpkg_cache
+          key: vcpkg-cache-centOS-${{ hashFiles('src/vcpkg.json', '.git/modules/vcpkg/HEAD') }}
+
       - name: Running unit tests
         timeout-minutes: 120
         shell: bash
         run: |
-          export PATH=${GITHUB_WORKSPACE}/vcpkg_installed/x64-linux/tools/openmpi/bin/:$PATH
+          export PATH=${GITHUB_WORKSPACE}/_build/vcpkg_installed/x64-linux/tools/openmpi/bin/:$PATH
           export LD_LIBRARY_PATH=LD_LIBRARY_PATH:${{ env.XPRS_LIB_Path_CONTAINER }}
           export XPRESS=${{ env.XPRESS_CONTAINER }}
           cd _build
           ctest -C Release --output-on-failure -L "unit|benders|lpnamer|medium"
+
+      #######################
+      - name: Install
+        run: |
+          cd _build
+          cmake --install .
+
+      - id: create-single-file
+        name: Single file .tar.gz creation
+        uses: ./.github/workflows/single-file-creation-tgz
+        with:
+          antares-xpansion-version: ${{steps.antares-xpansion-version.outputs.result}}
+
+      - name: Installer .tar.gz creation
+        run: |
+          cd _build
+          export FILE_NAME="antaresXpansion-${{steps.antares-xpansion-version.outputs.result}}-CentOS-7.9.2009"
+          cpack -G TGZ -D CPACK_PACKAGE_FILE_NAME=$FILE_NAME
+          #Need to differentiate between xpress/no_xpress files
+          #Cpack command line doesn't seem to care about -P or -R options
+          echo "TGZ_NAME=$FILE_NAME.tar.gz" >> $GITHUB_ENV
+
+      - name: Upload .tar.gz
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{env.TGZ_NAME}}
+          path: _build/${{env.TGZ_NAME}}
+
+      - name: Upload single file
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ steps.create-single-file.outputs.archive-name }}
+          path: ${{ steps.create-single-file.outputs.archive-path }}
+
+      - name: export asset name in output
+        id: export_output
+        run: |
+          echo "TGZ_NAME=${{env.TGZ_NAME}}" >> $GITHUB_OUTPUT
+          echo "SINGLE_FILE_NAME=${{ steps.create-single-file.outputs.archive-name }}" >> $GITHUB_OUTPUT
+
+      #######################
+  userguide:
+    if: github.event_name == 'release' && github.event.action == 'created'
+    runs-on: ubuntu-latest
+    outputs:
+      pdf-name: ${{ steps.create-user-guide.outputs.pdf-name }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Read antares-xpansion version
+        id: antares-xpansion-version
+        uses: ./.github/actions/read-json-value
+        with:
+          path: 'antares-version.json'
+          key: 'antares_xpansion_version'
+
+      - id: create-user-guide
+        name: user guide pdf creation
+        uses: ./.github/workflows/generate-userguide-pdf
+        with:
+          antares-xpansion-version: ${{steps.antares-xpansion-version.outputs.result}}
+
+      - name: user guide upload
+        id: userguide_upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: user-guide
+          path: ${{ steps.create-user-guide.outputs.pdf-path }}
+
+  release:
+    runs-on: ubuntu-latest
+    needs: [ build, userguide ]
+    if: github.event_name == 'release' && github.event.action == 'created'
+    steps:
+      - name: Download userguide
+        uses: actions/download-artifact@v4
+        with:
+          name: user-guide
+          path: docs/
+
+      - name: Download build assets
+        uses: actions/download-artifact@v3 #build use v3
+        with:
+          name: ${{needs.build.outputs.TGZ_NAME}}
+          path: _build/
+
+      - name: Download build assets single file
+        uses: actions/download-artifact@v3
+        with:
+          name: ${{needs.build.outputs.SINGLE_FILE_NAME}}
+          path: .
+
+      - name: Get release
+        id: get_release
+        uses: bruceadams/get-release@main
+
+      - name: Upload Release Asset
+        env:
+          GH_REPO: ${{ github.repository }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release upload --repo ${{env.GH_REPO}} ${{ steps.get_release.outputs.tag_name }} _build/${{needs.build.outputs.TGZ_NAME}}
+          gh release upload --repo ${{env.GH_REPO}} ${{ steps.get_release.outputs.tag_name }} ${{needs.build.outputs.SINGLE_FILE_NAME}}
diff --git a/.github/workflows/build_oracle8.yml b/.github/workflows/build_oracle8.yml
@@ -63,6 +63,10 @@ jobs:
       XPRESS_CONTAINER: ${GITHUB_WORKSPACE}/xpress/bin
       XPRS_LIB_Path_CONTAINER: ${GITHUB_WORKSPACE}/xpress/lib
 
+    outputs:
+      zip_name: ${{ steps.zip_name.outputs.zip_name }}
+      singlefile_name: ${{ steps.zip_name.outputs.singlefile_name }}
+
     steps:
       - name: Install System
         run: |
@@ -119,20 +123,25 @@ jobs:
         run: |
           pushd vcpkg
           git fetch --unshallow
-          ./bootstrap-vcpkg.sh
-          popd
-          vcpkg/vcpkg install
+          ./bootstrap-vcpkg.sh --disableMetrics
+
+      - name: Restore vcpkg binary dir from cache
+        id: cache-vcpkg-binary
+        uses: actions/cache/restore@v4
+        with:
+          path: ${{ github.workspace }}/vcpkg_cache
+          key: vcpkg-cache-oracle8-${{ hashFiles('src/vcpkg.json', '.git/modules/vcpkg/HEAD') }}
+          # Allows to restore a cache when deps have only partially changed (like adding a dependency)
+          restore-keys: vcpkg-cache-oracle8-
 
       - name: Configure
         run: |
-          [[ ${{ matrix.xprs.value }} == "XPRESS-ON" ]] && XPRESS_VALUE="ON" || XPRESS_VALUE="OFF" 
           cmake -B _build -S . \
                  -DDEPS_INSTALL_DIR=rte-antares-deps-Release \
                  -DBUILD_TESTING=ON \
                  -DCMAKE_BUILD_TYPE=Release \
                  -DCMAKE_INSTALL_PREFIX=_install \
                  -DBUILD_UI=OFF \
-                 -DXPRESS=${{ env.XPRESS_VALUE }} \
                  -DALLOW_RUN_AS_ROOT=ON \
                  -DCMAKE_TOOLCHAIN_FILE=vcpkg/scripts/buildsystems/vcpkg.cmake
 
@@ -144,8 +153,115 @@ jobs:
         timeout-minutes: 120
         shell: bash
         run: |
-          export PATH=${GITHUB_WORKSPACE}/vcpkg_installed/x64-linux/tools/openmpi/bin/:$PATH
+          export PATH=${GITHUB_WORKSPACE}/_build/vcpkg_installed/x64-linux/tools/openmpi/bin/:$PATH
           export LD_LIBRARY_PATH=LD_LIBRARY_PATH:${{ env.XPRS_LIB_Path_CONTAINER }}
           export XPRESS=${{ env.XPRESS_CONTAINER }}
           cd _build
           ctest -C Release --output-on-failure -L "unit|benders|lpnamer|medium"
+          
+      - name: Cache vcpkg binary dir
+        if: always()
+        id: save-cache-vcpkg-binary
+        uses: actions/cache/save@v4
+        with:
+          path: ${{ github.workspace }}/vcpkg_cache
+          key: vcpkg-cache-oracle8-${{ hashFiles('src/vcpkg.json', '.git/modules/vcpkg/HEAD') }}
+
+      #######################
+      - name: Install
+        run: |
+          cd _build
+          cmake --install .
+          
+      - name: .tar.gz creation
+        run: |
+          cd _build
+          export FILE_NAME="antaresXpansion-${{needs.versions.outputs.antares-xpansion-version}}-OracleServer-8.9"
+          cpack -G TGZ -D CPACK_PACKAGE_FILE_NAME=$FILE_NAME
+          echo "TGZ_NAME=$FILE_NAME.tar.gz" >> $GITHUB_ENV
+
+      - name: Upload .tar.gz
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{env.TGZ_NAME}}
+          path: _build/${{env.TGZ_NAME}}
+
+      - id: create-single-file
+        name: Single file .tar.gz creation
+        uses: ./.github/workflows/single-file-creation-tgz
+        with:
+          antares-xpansion-version: ${{needs.versions.outputs.antares-xpansion-version}}
+
+      - name: Upload single file
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ steps.create-single-file.outputs.archive-name }}
+          path: ${{ steps.create-single-file.outputs.archive-path }}
+
+      - id: zip_name
+        run: |
+          echo "singlefile_name=${{steps.create-single-file.outputs.archive-name}}" >> "$GITHUB_OUTPUT"
+          echo "zip_name=${{env.TGZ_NAME}}" >> "$GITHUB_OUTPUT"
+      #######################
+  userguide:
+    if: github.event_name == 'release' && github.event.action == 'created'
+    runs-on: ubuntu-latest
+    outputs:
+      pdf-name: ${{ steps.create-user-guide.outputs.pdf-name }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Read antares-xpansion version
+        id: antares-xpansion-version
+        uses: ./.github/actions/read-json-value
+        with:
+          path: 'antares-version.json'
+          key: 'antares_xpansion_version'
+
+      - id: create-user-guide
+        name: user guide pdf creation
+        uses: ./.github/workflows/generate-userguide-pdf
+        with:
+          antares-xpansion-version: ${{steps.antares-xpansion-version.outputs.result}}
+
+      - name: user guide upload
+        id: userguide_upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: user-guide
+          path: ${{ steps.create-user-guide.outputs.pdf-path }}
+
+  upload_asset_to_release:
+    if: github.event_name == 'release' && github.event.action == 'created'
+    runs-on: ubuntu-latest
+    needs: [build, userguide]
+    env:
+      ZIP_NAME: ${{needs.build.outputs.zip_name}}
+      SINGLEFILE_NAME: ${{needs.build.outputs.singlefile_name}}
+    steps:
+      - name: Get release
+        id: get_release
+        uses: bruceadams/get-release@main
+
+      - name: Download Artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{env.ZIP_NAME}}
+          path: .
+
+      - name: Download Artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{env.SINGLEFILE_NAME}}
+          path: .
+
+      - name: Upload Release Asset
+        env:
+          GH_REPO: ${{ github.repository }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release upload --repo ${{env.GH_REPO}} ${{ steps.get_release.outputs.tag_name }} ${{env.ZIP_NAME}}
+          gh release upload --repo ${{env.GH_REPO}} ${{ steps.get_release.outputs.tag_name }} ${{env.SINGLEFILE_NAME}}
+
+      ########################