Merge branch 'main' into refactor/typing_workflow_record

Author: PProfizi

.ci/generate_operators_doc.py

@@ -20,15 +20,20 @@ def initialize_server(ansys_path=None, include_composites=False, include_sound=F
     if include_composites:
         print("Loading Composites Plugin")
         load_library(
-            Path(server.ansys_path)
+            filename=Path(server.ansys_path)
             / "dpf"
             / "plugins"
             / "dpf_composites"
-            / "composite_operators.dll"
+            / "composite_operators.dll",
+            name="composites",
         )
     if include_sound:
         print("Loading Acoustics Plugin")
-        load_library(Path(server.ansys_path) / "Acoustics" / "SAS" / "ads" / "dpf_sound.dll")
+        load_library(
+            filename=Path(server.ansys_path) / "Acoustics" / "SAS" / "ads" / "dpf_sound.dll",
+            name="sound",
+        )
+    print(f"Loaded plugins: {list(server.plugins.keys())}")
     return server
 
 

.github/workflows/ci.yml

@@ -2,7 +2,7 @@ name: CI
 
 on:
   pull_request:
-    types: [opened, synchronize, reopened, ready_for_review, closed, labeled]
+    types: [opened, synchronize, reopened, ready_for_review]
     branches-ignore:
       - '*no-ci*'
   push:
@@ -31,16 +31,14 @@ env:
 jobs:
   debug:
     runs-on: ubuntu-latest
-    if: github.event.action != 'closed'
     steps:
-    - name: Show the Github context for the triggered event
+    - name: Show the GitHub context for the triggered event
       run: echo "$GITHUB_CONTEXT"
       env:
         GITHUB_CONTEXT: ${{ toJson(github) }}
 
   pick_server_suffix:
     runs-on: ubuntu-latest
-    if: github.event.action != 'closed' && (github.event.action != 'labeled' || github.event.label.name == 'deploy-pr-doc')
     outputs:
       suffix: ${{ steps.step1.outputs.suffix }}
     steps:
@@ -71,7 +69,6 @@ jobs:
   style:
     name: "Style Check"
     runs-on: ubuntu-latest
-    if: github.event.action != 'closed' && (github.event.action != 'labeled' || github.event.label.name == 'deploy-pr-doc')
     steps:
       - uses: ansys/actions/code-style@v8
         with:
@@ -80,7 +77,6 @@ jobs:
   build_linux1:
     name: "Build linux1 wheel"
     runs-on: ubuntu-latest
-    if: github.event.action != 'closed' && (github.event.action != 'labeled' || github.event.label.name == 'deploy-pr-doc')
     steps:
       - uses: actions/checkout@v4
 
@@ -111,7 +107,6 @@ jobs:
       matrix:
         test-any: ['false', 'true']
     uses: ./.github/workflows/tests.yml
-    if: github.event.action != 'closed' && (github.event.action != 'labeled' || github.event.label.name == 'deploy-pr-doc')
     needs: pick_server_suffix
     with:
       ANSYS_VERSION: ${{ inputs.ansys_version || vars.ANSYS_VERSION_DEFAULT }}
@@ -126,7 +121,6 @@ jobs:
   docker_tests:
     name: "Build and Test on Docker"
     uses: ./.github/workflows/test_docker.yml
-    if: github.event.action != 'closed' && (github.event.action != 'labeled' || github.event.label.name == 'deploy-pr-doc')
     needs: pick_server_suffix
     with:
       ANSYS_VERSION: ${{ inputs.ansys_version || vars.ANSYS_VERSION_DEFAULT }}
@@ -136,7 +130,6 @@ jobs:
   docker_examples:
     name: "Run examples on Docker"
     uses: ./.github/workflows/examples_docker.yml
-    if: github.event.action != 'closed' && (github.event.action != 'labeled' || github.event.label.name == 'deploy-pr-doc')
     needs: pick_server_suffix
     with:
       ANSYS_VERSION: ${{ inputs.ansys_version || vars.ANSYS_VERSION_DEFAULT }}
@@ -146,8 +139,6 @@ jobs:
 
   docs:
     if: |
-      github.event.action != 'closed' &&
-      (github.event.action != 'labeled' || github.event.label.name == 'deploy-pr-doc') &&
       (startsWith(github.head_ref, 'main') || github.event.action == 'ready_for_review' || !github.event.pull_request.draft)
     uses: ./.github/workflows/docs.yml
     needs: pick_server_suffix
@@ -158,31 +149,9 @@ jobs:
       python_version: "3.11"
     secrets: inherit
 
-  doc-deploy-pr:
-    name: "Deploy PR documentation"
-    runs-on: ubuntu-latest
-    needs: docs
-    if: |
-      always() &&
-      github.event.pull_request.draft != true &&
-      (needs.docs.result == 'success' || needs.docs.result == 'skipped') &&
-      contains(github.event.pull_request.labels.*.name, 'deploy-pr-doc')
-    steps:
-      - 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
-
   upload-development-docs:
     runs-on: ubuntu-latest
     if: |
-      github.event.action != 'closed' &&
-      (github.event.action != 'labeled' || github.event.label.name == 'deploy-pr-doc') &&
       (github.ref == 'refs/heads/main' && github.event_name == 'push')
     needs: [docs]
     steps:
@@ -198,8 +167,6 @@ jobs:
 
   examples:
     if: |
-      github.event.action != 'closed' &&
-      (github.event.action != 'labeled' || github.event.label.name == 'deploy-pr-doc') &&
       (startsWith(github.head_ref, 'main') || github.event.action == 'ready_for_review' || !github.event.pull_request.draft)
     uses: ./.github/workflows/examples.yml
     needs: pick_server_suffix
@@ -212,8 +179,6 @@ jobs:
   pydpf-post:
     name: "PyDPF-Post"
     if: |
-      github.event.action != 'closed' &&
-      (github.event.action != 'labeled' || github.event.label.name == 'deploy-pr-doc') &&
       (startsWith(github.head_ref, 'main') || github.event.action == 'ready_for_review' || !github.event.pull_request.draft)
     uses: ./.github/workflows/pydpf-post.yml
     needs: pick_server_suffix
@@ -227,8 +192,6 @@ jobs:
   tests-retro:
     name: "Test DPF ${{ matrix.version }} compatibility"
     if: |
-      github.event.action != 'closed' &&
-      (github.event.action != 'labeled' || github.event.label.name == 'deploy-pr-doc') &&
       (startsWith(github.head_ref, 'main') || github.event.action == 'ready_for_review' || !github.event.pull_request.draft)
     strategy:
       fail-fast: false

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

@@ -0,0 +1,69 @@
+name: doc-deploy-PR
+
+on:
+  workflow_run:
+    workflows: [ci]
+    types: [completed]
+  pull_request:
+    types: [closed]
+
+env:
+  DOCUMENTATION_CNAME: 'dpf.docs.pyansys.com'
+
+jobs:
+  debug:
+    name: debug
+    runs-on: ubuntu-latest
+    env:
+      EVENT_OBJ:  ${{ toJson(github.event) }}
+    steps:
+        - run: echo $EVENT_OBJ
+  doc-deploy-pr:
+    name: "Deploy PR documentation"
+    runs-on: ubuntu-latest
+    if: |
+      (
+        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: 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 (if workflow_run)
+        if: ${{ github.event_name == 'workflow_run' }}
+        run: ls -R
+
+      - 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

.github/workflows/pydpf-post.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

CONTRIBUTORS.md

@@ -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)

SECURITY.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