Skip to content

Commit cacd8a9

Browse files
authored
Merge branch 'main' into maint/ubuntu_latest
2 parents 5ee90d5 + 16fd37e commit cacd8a9

File tree

10 files changed

+101
-23
lines changed

10 files changed

+101
-23
lines changed

.github/workflows/ci_cd.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ jobs:
6363
steps:
6464

6565
- name: "Download HTML documentation artifacts"
66-
uses: actions/download-artifact@v5
66+
uses: actions/download-artifact@v6
6767
with:
6868
name: documentation-html
6969
path: documentation-html
@@ -84,7 +84,7 @@ jobs:
8484
steps:
8585

8686
- name: "Download HTML documentation"
87-
uses: actions/download-artifact@v5
87+
uses: actions/download-artifact@v6
8888
with:
8989
name: documentation-html
9090
path: documentation-html
@@ -96,7 +96,7 @@ jobs:
9696
dest: documentation-html.zip
9797

9898
- name: "Download PDF documentation"
99-
uses: actions/download-artifact@v5
99+
uses: actions/download-artifact@v6
100100
with:
101101
name: documentation-pdf
102102
path: documentation-pdf
@@ -125,7 +125,7 @@ jobs:
125125
steps:
126126

127127
- name: "Download HTML documentation artifacts"
128-
uses: actions/download-artifact@v5
128+
uses: actions/download-artifact@v6
129129
with:
130130
name: documentation-html
131131
path: documentation-html

.github/workflows/nightly-build.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ jobs:
4545
make -C doc pdf
4646
4747
- name: Upload HTML documentation
48-
uses: actions/upload-artifact@v4.6.2
48+
uses: actions/upload-artifact@v5.0.0
4949
with:
5050
name: HTML-Documentation
5151
path: doc/_build/html
5252
retention-days: 7
5353

5454
- name: Upload PDF Documentation
55-
uses: actions/upload-artifact@v4.6.2
55+
uses: actions/upload-artifact@v5.0.0
5656
with:
5757
name: PDF-Documentation
5858
path: doc/_build/latex/pyansys*.pdf

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ repos:
22

33

44
- repo: https://github.com/astral-sh/ruff-pre-commit
5-
rev: v0.13.1
5+
rev: v0.14.3
66
hooks:
77
- id: ruff-check
88
- id: ruff-format
@@ -26,7 +26,7 @@ repos:
2626
- id: debug-statements
2727

2828
- repo: https://github.com/python-jsonschema/check-jsonschema
29-
rev: 0.34.0
29+
rev: 0.34.1
3030
hooks:
3131
- id: check-github-workflows
3232
name: "Check GitHub workflows"

CODE_OF_CONDUCT.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributor covenant code of conduct
2+
3+
## Pledge
4+
5+
In the interest of fostering an open and welcoming environment,
6+
all contributors and maintainers pledge to making participation
7+
in the Ansys project and community a harassment-free experience
8+
for everyone, regardless of age, body size, disability, ethnicity,
9+
sex characteristics, gender identity and expression, level of
10+
experience, education, socioeconomic status, nationality, personal
11+
appearance, race, religion, or sexual identity and orientation.
12+
13+
## Standards
14+
15+
Examples of behavior that contribute to creating a positive environment
16+
include:
17+
18+
* Using welcoming and inclusive language
19+
* Being respectful of differing viewpoints and experiences
20+
* Gracefully accepting constructive criticism
21+
* Focusing on what is best for the community
22+
* Showing empathy towards other community members
23+
24+
Examples of unacceptable behavior by participants include:
25+
26+
* The use of sexualized language or imagery and unwelcome sexual
27+
attention or advances
28+
* Trolling, insulting/derogatory comments, and personal or political attacks
29+
* Public or private harassment
30+
* Publishing others' private information, such as a physical or electronic
31+
address, without explicit permission
32+
* Other conduct which could reasonably be considered inappropriate in a
33+
professional setting
34+
35+
## Responsibilities
36+
37+
Project maintainers are responsible for clarifying the standards of acceptable
38+
behavior and are expected to take appropriate and fair corrective action in
39+
response to any instances of unacceptable behavior.
40+
41+
Project maintainers have the right and responsibility to remove, edit, or reject
42+
comments, commits, code, wiki edits, issues, and other contributions that are
43+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
44+
contributor for other behaviors that they deem inappropriate, threatening,
45+
offensive, or harmful.
46+
47+
## Scope
48+
49+
This Code of Conduct applies both within project spaces and in public spaces
50+
when an individual is representing the project or its community. Examples of
51+
representing a project or community include using an official project email
52+
address, posting using an official social media account, or acting as an appointed
53+
representative at an online or offline event. Representation of a project may be
54+
further defined and clarified by project maintainers.
55+
56+
## Attribution
57+
58+
This code of conduct is adapted from the [Contributor Covenant][homepage],
59+
version 1.4, available at
60+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
61+
62+
[homepage]: https://www.contributor-covenant.org
63+
64+
For answers to common questions about this code of conduct, see
65+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
# Contributing
1+
# Contribute
22

3-
We absolutely welcome any code contributions and we hope that this
4-
guide will facilitate an understanding of the PyAnsys-dev-guide code
5-
repository. It is important to note that while the PyAnsys-dev-guide software
6-
package is maintained by ANSYS and any submissions will be reviewed
7-
thoroughly before merging, we still seek to foster a community that can
8-
support user questions and develop new features to make this software
9-
a useful tool for all users. As such, we welcome and encourage any
10-
questions or submissions to this repository.
3+
Overall guidance on contributing to a PyAnsys library appears in the
4+
[Contributing] topic in the *PyAnsys developer's guide*. Ensure that you
5+
are thoroughly familiar with this guide before attempting to contribute to
6+
{project-name}.
117

12-
For further information about contributing to PyAnsys projects,
13-
refer to the [PyAnsys Developer's Guide](https://dev.docs.pyansys.com/).
8+
The following contribution information is specific to the PyAnsys Developer's Guide.
149

10+
[Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html
11+
12+
<!-- Begin content specific to your library here. -->

doc/source/how-to/releasing.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,13 @@ control system.
9595
| |uncheck| All documentation builds successfully.
9696
| |uncheck| The project builds successfully.
9797
98+
.. note:: Pre-releases
99+
100+
To perform a pre-release, the process is the same as described below, with the exception
101+
of using a pre-release tag that follows `PEP 440 <https://peps.python.org/pep-0440/>`_.
102+
Furthermore, limiting pre-release tags to ``N.N.N[{a|b|rc}N]`` subset is encouraged for
103+
PyAnsys libraries.
104+
98105
.. dropdown:: Release major and minor versions
99106

100107
Before performing a release, you must verify that your ``origin main`` branch is up to date

doc/source/how-to/vulnerabilities.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -622,7 +622,7 @@ Fixing it is important because malicious inputs could execute unintended command
622622
run: |
623623
echo ${{ github.workspace }} # Template expansions are resolved before workflows and jobs run. These expansions
624624
echo ${{ runner.temp }} # insert their results directly into the context, which can accidentally introduce shell injection risks.
625-
echo ${{ input.user-input }} # This is especially through when such expansion is from a user input.
625+
echo ${{ input.user-input }} # This is especially true when such expansion is from a user input.
626626
627627
628628
.. tab-item:: Remediation

doc/source/packaging/diag/grpc_structure_diag.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@
1919
label="ansys-api-product", shape="folder"
2020
];
2121

22+
src [
23+
label="src", shape="folder"
24+
];
25+
2226
ansys [
2327
label="ansys", shape="folder"
2428
];
@@ -44,7 +48,8 @@
4448
];
4549

4650

47-
ansys_api_product -> ansys;
51+
ansys_api_product -> src;
52+
src -> ansys;
4853
ansys -> api;
4954
api -> product;
5055
product -> version;

doc/source/packaging/structure.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,9 @@ for build-system backend tools commonly used in the Python ecosystem:
307307

308308
.. include:: code/pyproject_code.rst
309309

310+
Optional files
311+
==============
312+
310313
The ``setup.py`` file
311314
---------------------
312315

requirements/requirements_doc.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
Sphinx==8.2.3
2-
ansys-sphinx-theme==1.6.1
2+
ansys-sphinx-theme==1.6.3
33
sphinx-copybutton==0.5.2
44
sphinx_toolbox==4.0.0
55
sphinx_design==0.6.1
66
sphinxcontrib-mermaid>=0.7.1
77
sphinx-gallery==0.19.0
88
Pillow>=9.0
9-
pyvista==0.46.3
9+
pyvista==0.46.4

0 commit comments

Comments
 (0)