Merge branch 'main' into AnsMelanie/op-doc/update-description

Author: PProfizi

.ci/generate_operators_doc.py

@@ -2,8 +2,10 @@ name: doc-deploy-PR
 
 on:
   workflow_run:
-    workflows: [docs]
+    workflows: [ci]
     types: [completed]
+  pull_request:
+    types: [closed]
 
 env:
   DOCUMENTATION_CNAME: 'dpf.docs.pyansys.com'
@@ -20,27 +22,48 @@ jobs:
     name: "Deploy PR documentation"
     runs-on: ubuntu-latest
     if: |
-      github.event.workflow_run.conclusion == 'success' &&
-      contains(github.event.workflow_run.pull_requests.*.labels.*.name, 'deploy-pr-doc')
+      (
+        github.event_name == 'workflow_run' &&
+        github.event.workflow_run.conclusion == 'success' &&
+        contains(github.event.workflow_run.pull_requests.*.labels.*.name, 'deploy-pr-doc')
+      ) || (
+        github.event_name == 'pull_request' &&
+        github.event.action == 'closed' &&
+        contains(github.event.pull_request.labels.*.name, 'deploy-pr-doc')
+      )
     steps:
-      - name: "Download artifacts"
+      - name: Set PR number
+        id: pr
+        run: |
+          if [[ "${{ github.event_name }}" == "workflow_run" ]]; then
+            echo "pr_number=${{ fromJson(toJson(github.event.workflow_run.pull_requests[0])).number }}" >> "$GITHUB_OUTPUT"
+          else
+            echo "pr_number=${{ github.event.pull_request.number }}" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Print PR number
+        run: echo "PR number is ${{ steps.pr.outputs.pr_number }}"
+
+      - name: Download artifacts (if workflow_run)
+        if: ${{ github.event_name == 'workflow_run' }}
         uses: dawidd6/action-download-artifact@v11
         with:
           workflow: docs.yml
           name: HTML-doc-ansys-dpf-core.zip
           github_token: ${{ secrets.GITHUB_TOKEN }}
           run_id: ${{ github.event.workflow_run.id }}
 
-
-      - name: "Display downloaded files"
+      - name: Display downloaded files (if workflow_run)
+        if: ${{ github.event_name == 'workflow_run' }}
         run: ls -R
 
-      - uses: ansys/actions/doc-deploy-pr@v10
+      - name: Deploy PR documentation
+        uses: ansys/actions/doc-deploy-pr@v10
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
           doc-artifact-name: HTML-doc-ansys-dpf-core.zip
           decompress-artifact: true
           bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
           bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
-          maximum-pr-doc-deployments: 10
+          maximum-pr-doc-deployments: 10

.github/workflows/doc-deploy-pr.yml

@@ -122,7 +122,7 @@ jobs:
           echo branch="$BranchName"
           if [ "$BranchName" = '' ];
           then
-              BranchName=$(git ls-remote --tags --refs $REPO | tail -n1 | cut -d/ -f3)
+              BranchName=$(git ls-remote --tags --sort="v:refname" --refs $REPO | tail -n1 | cut -d/ -f3)
           fi
           echo branch=$BranchName
           git clone --single-branch --branch "$BranchName" $REPO

.github/workflows/pydpf-post.yml

@@ -7,6 +7,7 @@ New-Item -Path ".\" -Name "test_remote_workflow" -ItemType "directory"
 New-Item -Path ".\" -Name "test_remote_operator" -ItemType "directory"
 New-Item -Path ".\" -Name "test_service" -ItemType "directory"
 New-Item -Path ".\" -Name "test_custom_type_field" -ItemType "directory"
+New-Item -Path ".\" -Name "test_documentation" -ItemType "directory"
 Copy-Item -Path "tests\conftest.py" -Destination ".\test_launcher\"
 Copy-Item -Path "tests\conftest.py" -Destination ".\test_server\"
 Copy-Item -Path "tests\conftest.py" -Destination ".\test_local_server\"
@@ -16,6 +17,7 @@ Copy-Item -Path "tests\conftest.py" -Destination ".\test_remote_workflow\"
 Copy-Item -Path "tests\conftest.py" -Destination ".\test_remote_operator\"
 Copy-Item -Path "tests\conftest.py" -Destination ".\test_service\"
 Copy-Item -Path "tests\conftest.py" -Destination ".\test_custom_type_field\"
+Copy-Item -Path "tests\conftest.py" -Destination ".\test_documentation\"
 Copy-Item -Path "tests\test_launcher.py" -Destination ".\test_launcher\"
 Copy-Item -Path "tests\test_server.py" -Destination ".\test_server\"
 Copy-Item -Path "tests\test_local_server.py" -Destination ".\test_local_server\"
@@ -25,6 +27,7 @@ Copy-Item -Path "tests\test_remote_workflow.py" -Destination ".\test_remote_work
 Copy-Item -Path "tests\test_remote_operator.py" -Destination ".\test_remote_operator\"
 Copy-Item -Path "tests\test_service.py" -Destination ".\test_service\"
 Copy-Item -Path "tests\test_custom_type_field.py" -Destination ".\test_custom_type_field\"
+Copy-Item -Path "tests\test_documentation.py" -Destination ".\test_documentation\"
 Remove-Item -Path "tests\test_server.py"
 Remove-Item -Path "tests\test_launcher.py"
 Remove-Item -Path "tests\test_local_server.py"
@@ -33,4 +36,5 @@ Remove-Item -Path "tests\test_workflow.py"
 Remove-Item -Path "tests\test_remote_workflow.py"
 Remove-Item -Path "tests\test_remote_operator.py"
 Remove-Item -Path "tests\test_service.py"
-Remove-Item -Path "tests\test_custom_type_field.py"
+Remove-Item -Path "tests\test_custom_type_field.py"
+Remove-Item -Path "tests\test_documentation.py"

.github/workflows/scripts/separate_long_core_tests.ps1

@@ -205,6 +205,15 @@ jobs:
           command: |
             pytest $DEBUG $COVERAGE $RERUNS --junitxml=../tests/junit/test-results12.xml tests/operators/.
 
+      - name: "Test Documentation"
+        uses: nick-fields/retry@v3
+        with:
+          timeout_minutes: 4
+          max_attempts: 2
+          shell: bash
+          command: |
+            pytest $DEBUG $COVERAGE $RERUNS --junitxml=../tests/junit/test-results13.xml test_documentation/.
+
 #      - name: "Test API Entry"
 #        shell: bash
 #        working-directory: tests

.github/workflows/test_docker.yml

@@ -35,6 +35,7 @@
 * [Jose Armando Henriquez Roa](https://github.com/jose-henriquez-roa)
 * [jose-henriquezroa](https://github.com/jose-henriquezroa)
 * [Joshua Fairchild](https://github.com/joshuafairch)
+* [Josip Vidal Orlovac](https://github.com/jvidalor)
 * [jviqueg](https://github.com/jviqueg)
 * [Kathy Pippert](https://github.com/PipKat)
 * [kmahajan-cadfem](https://github.com/kmahajan-cadfem)

CONTRIBUTORS.md

@@ -0,0 +1,14 @@
+## Reporting a vulnerability
+
+> [!CAUTION]
+> Do not use GitHub issues to report any security vulnerabilities.
+
+If you detect a vulnerability, contact the [PyAnsys Core team](mailto:[email protected]),
+mentioning the repository and the details of your finding. The team will address it as soon as possible.
+
+Provide the PyAnsys Core team with this information:
+
+- Any specific configuration settings needed to reproduce the problem
+- Step-by-step guidance to reproduce the problem
+- The exact location of the problematic source code, including tag, branch, commit, or a direct URL
+- The potential consequences of the vulnerability, along with a description of how an attacker could take advantage of the issue