Update versions of actions/download-artifact and actions/upload-artifact

[alxbilger]

It concerns SOFA plugins relying on GitHub actions.

actions/download-artifact@v3 is scheduled for deprecation on November 30, 2024. Similarly, v1/v2 are scheduled for deprecation on June 30, 2024. Please update your workflow to use v4 of the artifact actions.

actions/upload-artifact@v3 is scheduled for deprecation on November 30, 2024. Similarly, v1/v2 are scheduled for deprecation on June 30, 2024. Please update your workflow to use v4 of the artifact actions.

Both actions are massively used in SOFA plugins. Most of them still use the v2. They need to be upgraded

In some SOFA plugins, GitHub has used a bot to upgrade actions/download-artifact. Unfortunately, it's only half of the job. actions/upload-artifact must be upgraded too. There is even an incompatibility between actions/upload-artifact@v2 and actions/download-artifact@v4.1.7 (the version suggested by the bot). This incompatibility make the build failing.

Unfortunately, the new versions of the actions have new rules: some characters are forbidden in the name of the artifact to avoid cross-platform problems. That is why the name of the artifact must be sanitized first.

Here are the changes I recommend:

1. Upgrade the version of actions/download-artifact from v2 to v4.1.7

      - name: Install artifact
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4.1.7

2. Upgrade the version of actions/upload-artifact from v2 to v4.4.0

      - name: Create artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4.4.0

3. Sanitize the name of the artifact (only if the artifact name may contain the forbidden characters " : < > | * ? \r \n \ /)

      - name: Sanitize artifact name
        id: sanitize
        # This step removes special characters from the artifact name to ensure compatibility with upload-artifact
        # Characters removed: " : < > | * ? \r \n \ /
        # Spaces are replaced with underscores
        # This sanitization prevents errors in artifact creation and retrieval
        shell: pwsh
        run: |
          $originalName = "Cosserat_${{ steps.sofa.outputs.run_branch }}_for-SOFA-${{ steps.sofa.outputs.sofa_version }}_${{ runner.os }}"
          $artifact_name = $originalName -replace '[":;<>|*?\r\n\\/]', '' -replace ' ', '_'
          echo "artifact_name=$artifact_name" >> $env:GITHUB_OUTPUT

      - name: Create artifact
        uses: actions/upload-artifact@v4.4.0
        with:
          name: ${{ steps.sanitize.outputs.artifact_name }}
          path: ${{ env.WORKSPACE_INSTALL_PATH }}

      - name: Install artifact
        uses: actions/download-artifact@v4.1.7
        with:
          name: ${{ steps.sanitize.outputs.artifact_name }}
          path: ${{ env.WORKSPACE_ARTIFACT_PATH }}

Examples where those changes have been applied:

• Bump actions/download-artifact from 2 to 4.1.7 in /.github/workflows SofaDefrost/ModelOrderReduction#140 the bot branch has been modified before the merge
• Bump actions/download-artifact from 2 to 4.1.7  SofaGLFW#131 no PR from the security bot
• Bump actions/download-artifact from 2 to 4.1.7 in /.github/workflows SofaDefrost/Cosserat#129
• Bump actions/download-artifact from 2 to 4.1.7 in /.github/workflows SofaDefrost/SoftRobots#300

[alxbilger]

The following repos has been updated:

• Bump actions/download-artifact from 2 to 4.1.7 in /.github/workflows SofaDefrost/ModelOrderReduction#140
• Bump actions/download-artifact from 2 to 4.1.7  SofaGLFW#131
• Bump actions/download-artifact from 2 to 4.1.7 in /.github/workflows SofaDefrost/Cosserat#129
• Bump actions/download-artifact from 2 to 4.1.7 in /.github/workflows SofaDefrost/SoftRobots#300
• Bump actions/download-artifact from 2 to 4.1.7 SofaDefrost/SoftRobots.Inverse#41
• [ci] Sanitize the github workflow BeamAdapter#157
• CI artifact version update SofaDefrost/STLIB#125
• Update versions of actions/download-artifact and actions/upload-artifact SofaDefrost/Shell#5
• Sanitize the github workflow SofaDefrost/SofaViscoElastic#26
• update workflow ShapeMatchingPlugin#4
• Sanitize the github workflow Regression#70
• CI upload artifact version update SofaPython3#448
• Update ci.yml CGALPlugin#19
• Update ci.yml SofaSphFluid#6
• update ci SofaMJEDFEM#5
• [CI] upload artifact version update SofaHapticAvatar#31
• Sanitize the github workflow OptiTrackNatNet#4
• udpate ci Registration#17
• Bump actions/download-artifact from 2 to 4.1.7 THMPGSpatialHashing#3
• CI upload artifact version update Sofa.Metis#3
• [ci] Sanitize the github workflow ManifoldTopologies#10
• Bump actions/download-artifact from 2 to 4.1.7 Optimus#19
• CI upload artifact version update Sofa.IGTLink#7

[github-actions[bot]]

⚠️ ⚠️ ⚠️
@alxbilger
Feedback has been given to you by the project reviewers, however we have not received a response from you. Without further news in the coming weeks, this discussion will be automatically closed in order to keep this forum clean and fresh 🌱 Thank you for your understanding

[github-actions[bot]]

⚠️ ⚠️ ⚠️
@alxbilger
In accordance with our forum management policy, the last reply is more than 4 months old and is therefore closed. Our objective is to keep the forum up to date and offer the best support experience.

Please feel free to reopen it if the topic is still active by providing us with an update. Please feel free to open a new thread at any time - we'll be happy to help where and when we can.