From 1c14b3aebbefbd6d2d77d0be5ffe183fb39e27d7 Mon Sep 17 00:00:00 2001 From: viseshrp <11642379+viseshrp@users.noreply.github.com> Date: Wed, 25 Jun 2025 13:39:23 -0400 Subject: [PATCH 1/4] Create docs.yml --- .github/workflows/docs.yml | 57 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 000000000..0cb034081 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,57 @@ +name: Release Docs + +on: + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +env: + DOCUMENTATION_CNAME: 'dynamicreporting.docs.pyansys.com' + MAIN_PYTHON_VERSION: '3.13' + PACKAGE_NAME: 'ansys-dynamicreporting-core' + PACKAGE_NAMESPACE: 'ansys.dynamicreporting.core' + +jobs: + docs: + name: Build docs + runs-on: ubuntu-latest + steps: + - name: Run Ansys documentation building action + uses: ansys/actions/doc-build@v10 + with: + python-version: ${{ env.MAIN_PYTHON_VERSION }} + check-links: false + sphinxopts: '-j auto' + + upload_docs_release: + name: Upload release documentation + if: github.event_name == 'push' && contains(github.ref, 'refs/tags') + runs-on: ubuntu-latest + needs: [ docs ] + steps: + - name: Deploy the stable documentation + uses: ansys/actions/doc-deploy-stable@v10 + if: ${{ !env.ACT }} + with: + cname: ${{ env.DOCUMENTATION_CNAME }} + token: ${{ secrets.GITHUB_TOKEN }} + bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }} + bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }} + + ci-failure: + name: Teams notify on failure + if: failure() && (github.event_name == 'pull_request' || github.ref == 'refs/heads/main' || github.ref_type == 'tag') + needs: [ docs, upload_docs_release ] + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Microsoft Teams Notification + uses: jdcargile/ms-teams-notification@v1.4 + with: + github-token: ${{ github.token }} + ms-teams-webhook-uri: ${{ secrets.MS_TEAMS_WEBHOOK_URI_CI }} + notification-summary: CI build failure + notification-color: dc3545 + timezone: America/New_York From 1978b6db7da441bf054cb979e48d47d89643915b Mon Sep 17 00:00:00 2001 From: viseshrp <11642379+viseshrp@users.noreply.github.com> Date: Wed, 25 Jun 2025 13:41:21 -0400 Subject: [PATCH 2/4] Update docs.yml --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 0cb034081..76c0a5e05 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -52,6 +52,6 @@ jobs: with: github-token: ${{ github.token }} ms-teams-webhook-uri: ${{ secrets.MS_TEAMS_WEBHOOK_URI_CI }} - notification-summary: CI build failure + notification-summary: Release documentation build failure notification-color: dc3545 timezone: America/New_York From 85a2b4c79bcc629ff1772cc7c2b9890f8f45ae82 Mon Sep 17 00:00:00 2001 From: viseshrp <11642379+viseshrp@users.noreply.github.com> Date: Wed, 25 Jun 2025 13:43:27 -0400 Subject: [PATCH 3/4] Update docs.yml --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 76c0a5e05..d2ec6e81d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -42,7 +42,7 @@ jobs: ci-failure: name: Teams notify on failure - if: failure() && (github.event_name == 'pull_request' || github.ref == 'refs/heads/main' || github.ref_type == 'tag') + if: failure() needs: [ docs, upload_docs_release ] runs-on: ubuntu-latest steps: From e20cec20748740946169c0e20e6cfcfdc3d1d7b4 Mon Sep 17 00:00:00 2001 From: viseshrp <11642379+viseshrp@users.noreply.github.com> Date: Wed, 25 Jun 2025 13:48:16 -0400 Subject: [PATCH 4/4] Update docs.yml --- .github/workflows/docs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index d2ec6e81d..3ab4402c9 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -27,7 +27,6 @@ jobs: upload_docs_release: name: Upload release documentation - if: github.event_name == 'push' && contains(github.ref, 'refs/tags') runs-on: ubuntu-latest needs: [ docs ] steps: