ci: adding pr docs preview action (#4173)

* feat: add deployment step for PR documentation in CI workflow

* feat: add PR documentation cleanup workflow for closed pull requests

* chore: adding changelog file 4173.miscellaneous.md [dependabot-skip]

* Update .github/workflows/ci.yml

* Update .github/workflows/ci.yml

* feat: add 'deploy pr docs' label and update CI workflow for PR documentation deployment

---------

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

Author: germa89

.github/labels.yml

@@ -150,3 +150,7 @@
 - name: build failed
   description: "Schedule build fails"
   color: E67E22
+
+- name: 'deploy pr docs'
+  description: Deploy pull request documentation
+  color: 76D7C4

.github/workflows/ci.yml

@@ -146,6 +146,21 @@ jobs:
       license-server: ${{ secrets.LICENSE_SERVER }}
       username: ${{ github.actor }}
       password: ${{ secrets.GITHUB_TOKEN }}
+  
+
+  doc-deploy-pr:
+    name: "Deploy PR documentation"
+    runs-on: ubuntu-latest
+    needs: docs-build
+    if: contains(github.event.pull_request.labels.*.name, 'deploy pr docs')
+    steps:
+      - uses: ansys/actions/[email protected]
+        with:
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+          bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
+          maximum-pr-doc-deployments: 3
 
 
   build-test-remote-matrix:

.github/workflows/pr-docs-cleaner.yml

@@ -0,0 +1,29 @@
+# This action cleans up the deployed documentation for pull requests
+# after they have been merged or closed.
+# The docs deployment is implemented in the main CICD file (`ci.yml`)
+# since it is in that workflow where the docs are built.
+# 
+# For more information see:
+# https://actions.docs.ansys.com/version/stable/doc-actions/index.html#doc-deploy-pr-action
+
+name: PR-docs cleaner
+
+on:
+  pull_request:
+    types: [closed]
+
+env:
+  DOCUMENTATION_CNAME: 'mapdl.docs.pyansys.com'
+
+jobs:
+  clean-docs-pr:
+    name: "Deploy PR documentation"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ansys/actions/[email protected]
+        with:
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+          bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
+          maximum-pr-doc-deployments: 3

doc/changelog.d/4173.miscellaneous.md

@@ -0,0 +1 @@
+Ci: adding pr docs preview action