Merge branch 'main' into release/0.5

Author: RobPasMue

.github/workflows/ci_cd.yml

@@ -38,7 +38,7 @@ jobs:
       contents: write
       pull-requests: write
     steps:
-      - uses: ansys/actions/doc-deploy-changelog@main
+      - uses: ansys/actions/doc-deploy-changelog@v6
         with:
           token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
 
@@ -48,15 +48,15 @@ jobs:
     steps:
       - name: PyAnsys Vulnerability check (on main)
         if: github.ref == 'refs/heads/main'
-        uses: ansys/actions/check-vulnerabilities@main
+        uses: ansys/actions/check-vulnerabilities@v6
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
           python-package-name: ${{ env.PACKAGE_NAME }}
           token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
 
       - name: PyAnsys Vulnerability check (on dev mode)
         if: github.ref != 'refs/heads/main'
-        uses: ansys/actions/check-vulnerabilities@main
+        uses: ansys/actions/check-vulnerabilities@v6
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
           python-package-name: ${{ env.PACKAGE_NAME }}
@@ -70,15 +70,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check branch name
-        uses: ansys/actions/branch-name-style@v5
+        uses: ansys/actions/branch-name-style@v6
 
   commit-name:
     if: github.event_name == 'pull_request'
     name: Check the name of the commit
     runs-on: ubuntu-latest
     steps:
       - name: Check commit name
-        uses: ansys/actions/commit-style@v5
+        uses: ansys/actions/commit-style@v6
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -87,7 +87,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys documentation style checks
-        uses: ansys/actions/doc-style@v5
+        uses: ansys/actions/doc-style@v6
         with:
          token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -106,7 +106,7 @@ jobs:
             os: macos-latest
     steps:
       - name: Build wheelhouse and perform smoke test
-        uses: ansys/actions/build-wheelhouse@v5
+        uses: ansys/actions/build-wheelhouse@v6
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           operating-system: ${{ matrix.os }}
@@ -117,7 +117,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys documentation style checks
-        uses: ansys/actions/docker-style@v5
+        uses: ansys/actions/docker-style@v6
         with:
           directory: docker
           recursive: true
@@ -404,7 +404,7 @@ jobs:
 
       - name: Run pytest
         if: env.SKIP_UNSTABLE == 'false'
-        uses: ansys/actions/tests-pytest@v5
+        uses: ansys/actions/tests-pytest@v6
         env:
           ALLOW_PLOTTING: true
         with:
@@ -437,13 +437,61 @@ jobs:
             docker rm ${{ env.GEO_CONT_NAME }}
           fi
 
+  testing-min-reqs:
+    name: Testing with minimum requirements
+    needs: [smoke-tests]
+    runs-on: ubuntu-latest
+    env:
+      ANSRV_GEO_IMAGE_MINREQS: 'ghcr.io/ansys/geometry:linux-latest'
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+    steps:
+      - name: Login in Github Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Pull and launch geometry service
+        run: |
+          docker pull ${{ env.ANSRV_GEO_IMAGE_MINREQS }}
+          docker run --detach --name ${{ env.GEO_CONT_NAME }} -e LICENSE_SERVER=${{ env.ANSRV_GEO_LICENSE_SERVER }} -p ${{ env.ANSRV_GEO_PORT }}:50051 ${{ env.ANSRV_GEO_IMAGE_MINREQS }}
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install minimum requirements
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[all,tests-minimal]
+          pip install pytest
+
+      - name: Run pytest
+        run: |
+          pytest -v
+
+      - name: Stop the Geometry service
+        if: always()
+        run: |
+          docker stop ${{ env.GEO_CONT_NAME }}
+          docker logs ${{ env.GEO_CONT_NAME }}
+          docker rm ${{ env.GEO_CONT_NAME }}
+
   package:
     name: Package library
-    needs: [testing-windows, testing-linux, docs]
+    needs: [testing-windows, testing-linux, testing-min-reqs, docs]
     runs-on: ubuntu-latest
     steps:
       - name: Build library source and wheel artifacts
-        uses: ansys/actions/build-library@v5
+        uses: ansys/actions/build-library@v6
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
@@ -634,7 +682,7 @@ jobs:
           restore-keys: pyvista-image-cache-${{ runner.os }}-v-${{ env.RESET_IMAGE_CACHE }}
 
       - name: Run pytest
-        uses: ansys/actions/tests-pytest@v5
+        uses: ansys/actions/tests-pytest@v6
         env:
           ALLOW_PLOTTING: true
         with:
@@ -670,14 +718,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Release to the public PyPI repository
-        uses: ansys/actions/release-pypi-public@v5
+        uses: ansys/actions/release-pypi-public@v6
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           twine-username: "__token__"
           twine-token: ${{ secrets.PYPI_TOKEN }}
 
       - name: Release to GitHub
-        uses: ansys/actions/release-github@v5
+        uses: ansys/actions/release-github@v6
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           additional-artifacts: windows-dockerfile.zip linux-dockerfile.zip
@@ -689,8 +737,7 @@ jobs:
     needs: [package]
     steps:
       - name: Deploy the latest documentation
-        # TODO: testing SEO improvements. This branch reuses the "index.html" from the stable version
-        uses: ansys/actions/doc-deploy-dev@feat/seo-improvements
+        uses: ansys/actions/doc-deploy-dev@v6
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
@@ -702,7 +749,7 @@ jobs:
     needs: upload_dev_docs
     steps:
       - name: "Deploy the latest documentation index"
-        uses: ansys/actions/doc-deploy-index@v5
+        uses: ansys/actions/doc-deploy-index@v6
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}/version/dev
           index-name: pyansys-geometry-vdev
@@ -717,9 +764,7 @@ jobs:
     needs: [release]
     steps:
       - name: Deploy the stable documentation
-        # TODO: testing SEO improvements. This branch avoids creating a
-        # sitemap.xml pages in opposite to v5.
-        uses: ansys/actions/doc-deploy-stable@feat/seo-improvements
+        uses: ansys/actions/doc-deploy-stable@v6
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
@@ -745,7 +790,7 @@ jobs:
           echo "VERSION_MEILI=$VERSION_MEILI" >> $GITHUB_ENV
 
       - name: "Deploy the latest documentation index"
-        uses: ansys/actions/doc-deploy-index@v5
+        uses: ansys/actions/doc-deploy-index@v6
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}/version/${{ env.VERSION }}
           index-name: pyansys-geometry-v${{ env.VERSION_MEILI }}

.github/workflows/docker_cleanup.yml

@@ -22,7 +22,7 @@ jobs:
     steps:
 
     - name: "Perform versions cleanup - except certain tags"
-      uses: ansys/actions/hk-package-clean-except@v5
+      uses: ansys/actions/hk-package-clean-except@v6
       with:
         package-name: 'geometry'
         token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/label.yml

@@ -96,6 +96,6 @@ jobs:
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
-    - uses: ansys/actions/doc-changelog@main
+    - uses: ansys/actions/doc-changelog@v6
       with:
         token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}

.github/workflows/nightly_docker_test.yml

@@ -122,7 +122,7 @@ jobs:
           docker run --detach --name ${{ env.GEO_CONT_NAME }} -e LICENSE_SERVER=${{ env.ANSRV_GEO_LICENSE_SERVER }} -p ${{ env.ANSRV_GEO_PORT }}:50051 ${{ env.ANSRV_GEO_IMAGE_LINUX_TAG }}
 
       - name: Run pytest
-        uses: ansys/actions/tests-pytest@v5
+        uses: ansys/actions/tests-pytest@v6
         env:
           ALLOW_PLOTTING: true
         with:

.pre-commit-config.yaml

@@ -37,7 +37,7 @@ repos:
   rev: v2.2.6
   hooks:
   - id: codespell
-    args: ["--ignore-words", "doc/styles/Vocab/ANSYS/accept.txt", "-w"]
+    args: ["--ignore-words", "doc/styles/config/vocabularies/ANSYS/accept.txt", "-w"]
 
 - repo: https://github.com/pycqa/pydocstyle
   rev: 6.3.0
@@ -55,7 +55,7 @@ repos:
   - id: trailing-whitespace
 
 - repo: https://github.com/ansys/pre-commit-hooks
-  rev: v0.2.9
+  rev: v0.3.1
   hooks:
     - id: add-license-headers
       files: '(src|examples|tests|docker)/.*\.(py)|\.(proto)'

CHANGELOG.md

@@ -1,74 +1,7 @@
 # CHANGELOG
 
-This project uses [towncrier](https://towncrier.readthedocs.io/) to generate changelogs. You can see the changes for the upcoming release in the [changelog fragment directory](https://github.com/ansys/pyansys-geometry/tree/main/doc/changelog.d).
+This project uses [towncrier](https://towncrier.readthedocs.io/) to generate changelogs.
 
-<!-- towncrier release notes start -->
+Refer to the [raw release notes](doc/source/changelog.rst) for more information.
 
-## [0.5.0](https://github.com/ansys/pyansys-geometry/releases/tag/v0.5.0) - 2024-04-17
-
-
-### Added
-
-- feat: inserting document into existing design [#930](https://github.com/ansys/pyansys-geometry/pull/930)
-- feat: add changelog action [#1023](https://github.com/ansys/pyansys-geometry/pull/1023)
-- feat: create a sphere body on the backend [#1035](https://github.com/ansys/pyansys-geometry/pull/1035)
-- feat: mirror a body [#1055](https://github.com/ansys/pyansys-geometry/pull/1055)
-- feat: sweeping chains and profiles [#1056](https://github.com/ansys/pyansys-geometry/pull/1056)
-- feat: vulnerability checks [#1071](https://github.com/ansys/pyansys-geometry/pull/1071)
-- feat: loft profiles [#1075](https://github.com/ansys/pyansys-geometry/pull/1075)
-- feat: accept bandit advisories in-line for subprocess [#1077](https://github.com/ansys/pyansys-geometry/pull/1077)
-- feat: adding containers to automatic launcher [#1090](https://github.com/ansys/pyansys-geometry/pull/1090)
-- feat: minor changes to Linux Dockerfile [#1111](https://github.com/ansys/pyansys-geometry/pull/1111)
-- feat: avoid error if folder exists [#1125](https://github.com/ansys/pyansys-geometry/pull/1125)
-
-### Changed
-
-- build: changing sphinx-autoapi from 3.1.a2 to 3.1.a4 [#1038](https://github.com/ansys/pyansys-geometry/pull/1038)
-- chore: add pre-commit.ci configuration [#1065](https://github.com/ansys/pyansys-geometry/pull/1065)
-- chore: dependabot PR automatic approval [#1067](https://github.com/ansys/pyansys-geometry/pull/1067)
-- ci: bump the actions group with 1 update [#1082](https://github.com/ansys/pyansys-geometry/pull/1082)
-- chore: update docker tags to be kept [#1085](https://github.com/ansys/pyansys-geometry/pull/1085)
-- chore: update pre-commit versions [#1094](https://github.com/ansys/pyansys-geometry/pull/1094)
-- build: use ansys-sphinx-theme autoapi target [#1097](https://github.com/ansys/pyansys-geometry/pull/1097)
-- fix: removing @PipKat from *.md files - changelog fragments [#1098](https://github.com/ansys/pyansys-geometry/pull/1098)
-- ci: dashboard upload does not apply anymore [#1099](https://github.com/ansys/pyansys-geometry/pull/1099)
-- chore: pre-commit.ci not working properly [#1108](https://github.com/ansys/pyansys-geometry/pull/1108)
-- chore: update and adding pre-commit.ci config hook [#1109](https://github.com/ansys/pyansys-geometry/pull/1109)
-- ci: main Python version update to 3.12 [#1112](https://github.com/ansys/pyansys-geometry/pull/1112)
-- ci: skip Linux tests with common approach [#1113](https://github.com/ansys/pyansys-geometry/pull/1113)
-- ci: build changelog on release [#1118](https://github.com/ansys/pyansys-geometry/pull/1118)
-- chore: update CHANGELOG for v0.5.0 [#1119](https://github.com/ansys/pyansys-geometry/pull/1119)
-
-### Fixed
-
-- feat: re-enable open file on Linux [#817](https://github.com/ansys/pyansys-geometry/pull/817)
-- fix: adapt export and download tests to new hoops [#1057](https://github.com/ansys/pyansys-geometry/pull/1057)
-- fix: linux Dockerfile - replace .NET6.0 references by .NET8.0 [#1069](https://github.com/ansys/pyansys-geometry/pull/1069)
-- fix: misleading docstring for sweep_chain() [#1070](https://github.com/ansys/pyansys-geometry/pull/1070)
-- fix: prepare_and_start_backend is only available on Windows [#1076](https://github.com/ansys/pyansys-geometry/pull/1076)
-- fix: unit tests failing after dms update [#1087](https://github.com/ansys/pyansys-geometry/pull/1087)
-- build: beartype upper limit on v0.18 [#1095](https://github.com/ansys/pyansys-geometry/pull/1095)
-- fix: improper types being passed for Face and Edge ctor. [#1096](https://github.com/ansys/pyansys-geometry/pull/1096)
-- fix: return type should be dict and not ``ScalarMapContainer`` (grpc type) [#1103](https://github.com/ansys/pyansys-geometry/pull/1103)
-- fix: env version for Dockerfile Windows [#1120](https://github.com/ansys/pyansys-geometry/pull/1120)
-- fix: changelog description ill-formatted [#1121](https://github.com/ansys/pyansys-geometry/pull/1121)
-- fix: solve issues with intersphinx when releasing [#1123](https://github.com/ansys/pyansys-geometry/pull/1123)
-
-### Dependencies
-
-- build: bump the docs-deps group with 2 updates [#1062](https://github.com/ansys/pyansys-geometry/pull/1062), [#1093](https://github.com/ansys/pyansys-geometry/pull/1093), [#1105](https://github.com/ansys/pyansys-geometry/pull/1105)
-- build: bump ansys-api-geometry from 0.3.13 to 0.4.0 [#1066](https://github.com/ansys/pyansys-geometry/pull/1066)
-- build: bump the docs-deps group with 1 update [#1080](https://github.com/ansys/pyansys-geometry/pull/1080)
-- build: bump pytest-cov from 4.1.0 to 5.0.0 [#1081](https://github.com/ansys/pyansys-geometry/pull/1081)
-- build: bump ansys-api-geometry from 0.4.0 to 0.4.1 [#1092](https://github.com/ansys/pyansys-geometry/pull/1092)
-- build: bump beartype from 0.17.2 to 0.18.2 [#1106](https://github.com/ansys/pyansys-geometry/pull/1106)
-- build: bump ansys-tools-path from 0.4.1 to 0.5.1 [#1107](https://github.com/ansys/pyansys-geometry/pull/1107)
-- build: bump panel from 1.4.0 to 1.4.1 in the docs-deps group [#1114](https://github.com/ansys/pyansys-geometry/pull/1114)
-- build: bump scipy from 1.12.0 to 1.13.0 [#1115](https://github.com/ansys/pyansys-geometry/pull/1115)
-
-
-### Miscellaneous
-
-- [pre-commit.ci] pre-commit autoupdate [#1063](https://github.com/ansys/pyansys-geometry/pull/1063)
-- docs: add examples on new methods [#1089](https://github.com/ansys/pyansys-geometry/pull/1089)
-- chore: pre-commit automatic update [#1116](https://github.com/ansys/pyansys-geometry/pull/1116)
+[Published release notes](https://geometry.docs.pyansys.com/version/stable/changelog.html) can be found in the online documentation.

LICENSE

@@ -1,13 +1,13 @@
 MIT License
 
-Copyright (c) 2022 ANSYS, Inc. All rights reserved.
+Copyright (c) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.

SECURITY.md

@@ -28,9 +28,9 @@ SOFTWARE.
 
 | Version | Supported          |
 | ------- | ------------------ |
-| <= 0.2  | :x:                |
-| 0.3.x   | :white_check_mark: |
+| <= 0.3  | :x:                |
 | 0.4.x   | :white_check_mark: |
+| 0.5.x   | :white_check_mark: |
 | dev     | :white_check_mark: |
 
 ## Reporting a Vulnerability

doc/.vale.ini

@@ -27,3 +27,4 @@ Vocab = ANSYS
 # Apply the following styles
 BasedOnStyles = Vale, Google
 Google.Headings = NO
+Vale.Terms = NO

doc/changelog.d/1126.added.md

@@ -0,0 +1 @@
+feat: security updates dropped for v0.3 or earlier