feat: prepend link to migration guide in GitHub release notes (#860)

Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
Co-authored-by: Sébastien Morais <146729917+SMoraisAnsys@users.noreply.github.com>

Author: 4 people

.github/workflows/ci_cd_release.yml

@@ -20,6 +20,8 @@ jobs:
   rolling-release:
     name: "Rolling release"
     runs-on: ubuntu-latest
+    outputs:
+      tag_major: ${{ steps.current-branch-tag-validity.outputs.MAJOR }}
     env:
       REF_NAME: ${{ github.ref_name }}
       BASE_REF: ${{ github.event.base_ref }}
@@ -184,7 +186,9 @@ jobs:
   release:
     name: "Release"
     runs-on: ubuntu-latest
-    needs: [doc-build, tests]
+    needs: [doc-build, tests, rolling-release]
+    env:
+        MAJOR: ${{ needs.rolling-release.outputs.tag_major }}
     permissions:
       id-token: write
       contents: write
@@ -232,9 +236,23 @@ jobs:
         skip-existing: false
         verbose: true
 
+    - name: "Generate link to migration guide for current release"
+      id: link-migration-guide
+      run: |
+        BASE_LINK="https://actions.docs.ansys.com/version/stable/migrations/index.html#version-v"
+        # Append version number to point to specific entry in the migration guide
+        LINK="${BASE_LINK}${MAJOR}"
+        echo "LINK=${LINK}" >> $GITHUB_OUTPUT
+
     - name: "Release to GitHub"
       uses: softprops/action-gh-release@da05d552573ad5aba039eaac05058a918a7bf631 # v2.2.2
       with:
+        body: >
+          If you are migrating the actions of your project to a new major release, breaking changes can be expected.
+
+          To make sure everything is compatible with your current workflow, refer to the
+          [Migration Guide for v${{ env.MAJOR }}](${{ steps.link-migration-guide.outputs.LINK }}) to find out more
+          about new features and potential breaking changes.
         generate_release_notes: true
         files: |
           documentation-html.zip

doc/source/changelog/860.added.md

@@ -0,0 +1 @@
+Prepend link to migration guide in github release notes