Merge branch 'main' into ci/pin-versions-and-cleanup-workflow

Author: SMoraisAnsys

.github/workflows/ci_cd.yml

@@ -61,14 +61,76 @@ jobs:
     runs-on: ubuntu-latest
     needs: doc-build
     steps:
+  
+      - name: "Download HTML documentation artifacts"
+        uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
+        with:
+          name: documentation-html
+          path: documentation-html
+
+      - uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: documentation-html
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          full_commit_message: ${{ github.event.head_commit.message }}
+          force_orphan: true
+
+  release-github:
+    name: "Release to GitHub"
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+    needs: doc-build
+    steps:
+
+    - name: "Download HTML documentation"
+      uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
+      with:
+        name: documentation-html
+        path: documentation-html
+
+    - name: "Zip HTML documentation"
+      uses: vimtor/action-zip@1379ea20d4c5705669ba81fd626dd01b1c738f26 # v1.2
+      with:
+        files: documentation-html
+        dest: documentation-html.zip
+
+    - name: "Download PDF documentation"
+      uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
+      with:
+        name: documentation-pdf
+        path: documentation-pdf
 
-      - name: Download HTML documentation artifacts
-        uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
+    - name: "Zip PDF documentation"
+      uses: vimtor/action-zip@1379ea20d4c5705669ba81fd626dd01b1c738f26 # v1.2
+      with:
+        files: documentation-pdf
+        dest: documentation-pdf
+
+    - name: "Display the structure of downloaded files"
+      shell: bash
+      run: ls -R
+
+    - name: "Release to GitHub"
+      uses: softprops/action-gh-release@5be0e66d93ac7ed76da52eca8bb058f665c3a5fe # v2.4.2
+      with:
+        files: |
+          documentation-html.zip
+          documentation-pdf
+
+  doc-deploy-github-release:
+    name: "Deploy documentation (stable)"
+    runs-on: ubuntu-latest
+    needs: [release-github]
+    steps:
+  
+      - name: "Download HTML documentation artifacts"
+        uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
         with:
           name: documentation-html
           path: documentation-html
 
-      - uses: peaceiris/actions-gh-pages@v4
+      - uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: documentation-html

.github/workflows/labeler.yml

@@ -13,7 +13,7 @@ jobs:
     name: Syncer
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - uses: micnncim/action-label-syncer@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -29,7 +29,7 @@ jobs:
 
     # Label based on modified files
     - name: Label based on changed files
-      uses: actions/labeler@v5
+      uses: actions/labeler@v6
       with:
         repo-token: "${{ secrets.GITHUB_TOKEN }}"
 

.github/workflows/nightly-build.yml

@@ -16,10 +16,10 @@ jobs:
       - name: Setup headless display
         uses: pyvista/setup-headless-display-action@v4
 
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
@@ -45,22 +45,22 @@ jobs:
           make -C doc pdf
 
       - name: Upload HTML documentation
-        uses: actions/upload-artifact@v4.6.2
+        uses: actions/upload-artifact@v5.0.0
         with:
           name: HTML-Documentation
           path: doc/_build/html
           retention-days: 7
 
       - name: Upload PDF Documentation
-        uses: actions/upload-artifact@v4.6.2
+        uses: actions/upload-artifact@v5.0.0
         with:
           name: PDF-Documentation
           path: doc/_build/latex/pyansys*.pdf
           retention-days: 7
 
       - name: Deploy to gh-pages
         if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
-        uses: JamesIves/[email protected].3
+        uses: JamesIves/[email protected].4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           branch: gh-pages

.pre-commit-config.yaml

@@ -2,13 +2,13 @@ repos:
 
 
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.12.9
+  rev: v0.14.7
   hooks:
     - id: ruff-check
     - id: ruff-format
 
 - repo: https://github.com/adamchainz/blacken-docs
-  rev: 1.19.1
+  rev: 1.20.0
   hooks:
   - id: blacken-docs
     additional_dependencies: [black==24.8.0]
@@ -26,7 +26,7 @@ repos:
   - id: debug-statements
 
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.33.3
+  rev: 0.35.0
   hooks:
     - id: check-github-workflows
       name: "Check GitHub workflows"

CODE_OF_CONDUCT.md

@@ -0,0 +1,65 @@
+# Contributor covenant code of conduct
+
+## Pledge
+
+In the interest of fostering an open and welcoming environment,
+all contributors and maintainers pledge to making participation
+in the Ansys project and community a harassment-free experience
+for everyone, regardless of age, body size, disability, ethnicity,
+sex characteristics, gender identity and expression, level of
+experience, education, socioeconomic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Standards
+
+Examples of behavior that contribute to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual
+  attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project email
+address, posting using an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Attribution
+
+This code of conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at
+<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+<https://www.contributor-covenant.org/faq>

CONTRIBUTING.md

@@ -1,14 +1,12 @@
-# Contributing
+# Contribute
 
-We absolutely welcome any code contributions and we hope that this
-guide will facilitate an understanding of the PyAnsys-dev-guide code
-repository. It is important to note that while the PyAnsys-dev-guide software
-package is maintained by ANSYS and any submissions will be reviewed
-thoroughly before merging, we still seek to foster a community that can
-support user questions and develop new features to make this software
-a useful tool for all users.  As such, we welcome and encourage any
-questions or submissions to this repository.
+Overall guidance on contributing to a PyAnsys library appears in the
+[Contributing] topic in the *PyAnsys developer's guide*. Ensure that you
+are thoroughly familiar with this guide before attempting to contribute to
+{project-name}.
 
-For further information about contributing to PyAnsys projects,
-refer to the [PyAnsys Developer's Guide](https://dev.docs.pyansys.com/).
+The following contribution information is specific to the PyAnsys Developer's Guide.
 
+[Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html
+
+<!-- Begin content specific to your library here. -->

doc/Makefile

@@ -19,10 +19,9 @@ help:
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 
-# customized clean due to examples gallery
+# customized clean
 clean:
-	rm -rf build
-	rm -rf source/examples/
+	rm -rf _build
 
 # customized pdf fov svg format images
 pdf:

doc/source/getting-started/administration.rst

@@ -21,6 +21,10 @@ This form lets the different parties involved in the public release process know
 there is a request to release a project. If your intent is to release an Ansys open
 source project, then continue to the next section.
 
+For more information, see
+:ref:`Questions asked on the OSS approval request form`.
+
+
 Approval process
 ----------------
 
@@ -61,13 +65,6 @@ When releasing a project to the public, you must perform these tasks:
 * Maintain the project by means of fixing bugs and providing support for new releases.
 * Uphold Ansys' reputation in the open source community.
 
-Once all three approvals have been awarded, project leads must then complete
-the `open source request form`_.
-
-This form serves as a final checklist to verify that all approvals have been processed
-and to formalize the OSS approval process as a final record. For more information, see
-:ref:`Questions asked on the OSS approval request form`.
-
 Managerial
 ^^^^^^^^^^
 
@@ -110,9 +107,9 @@ Legal
 Legal review approval ensures that the entire project complies with Ansys'
 legal policies.
 
-Click the following button to complete the legal review request form for open sourcing the code:
+Click the following button to complete the Chain of liability:
 
-.. button-link:: https://github.com/ansys-internal/oss-approval-tracklist/issues/new?assignees=MaxJPRey%2C+RobPasMue%2C+jorgepiloto%2C+&labels=&projects=&template=oss_final_signature.yml&title=Name+of+the+package+to+release
+.. button-link:: https://forms.office.com/Pages/ResponsePage.aspx?id=Z87GNLgV_06A6VLai-iXBlohdWpH-0xMs83xmsDFYEBUNEZNM0dBS0taWlMzWlpDRklIQ0tFVEVSTC4u
     :color: black
     :expand:
 

doc/source/how-to/compatibility.rst

@@ -34,9 +34,9 @@ introduced in an earlier version are also supported in later versions. Suppressi
 a feature would lead to a backward compatibility issue.
 
 Because the same type of issues can happen with the PyAnsys servers wrapping
-Ansys products, creating a similar *maximum version* data structure is
-is necessary. While there are no such implementations yet, it should work
-in the same way as the minimum version data structure.
+Ansys products, creating a similar *maximum version* data structure is necessary.
+While there are no such implementations yet, it should work in the same way as the
+minimum version data structure.
 
 ``version_requires`` decorator
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/source/how-to/grpc-api-packages.rst

@@ -276,6 +276,23 @@ underlying implementations.
 For each client library release, only a single gRPC API version should be wrapped
 to maintain a consistent API abstraction expectation for the supporting server instances.
 
+Securing connections
+~~~~~~~~~~~~~~~~~~~~
+
+It is possible to secure connections between the Python client library and the
+product servers.
+
+For developers, use the `cyberchannel`_ module provided in the
+`ansys-tools-common`_ to implement secure connections. This ensures compliance
+with the latest security standards defined by PyAnsys.
+
+For users, refer to the `certificates`_ section for creating and managing
+all necessary certificates for secure connections.
+
+.. _cyberchannel: https://tools.docs.pyansys.com/version/stable/user_guide/secure_grpc.html#the-cyberchannel-module
+.. _ansys-tools-common: https://tools.docs.pyansys.com
+.. _certificates: https://tools.docs.pyansys.com/version/0.3/user_guide/secure_grpc.html#generating-certificates-for-mtls
+
 Public versus private Python API package
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~