Skip to content

docs: updating needed files for release #709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
clatapie wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: updating needed files for release #709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d97e9b0
docs: updating needed files for release
clatapie Mar 3, 2026
33b3250
Merge branch 'main' into docs/update_release_files
RobPasMue Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/source/getting-started/administration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,8 @@ The PyAnsys core team performs these checks when performing the technical review
| |uncheck| :ref:`The \`\`LICENSE\`\` file` is present and compliant with legal requirements.
| |uncheck| :ref:`The \`\`CONTRIBUTING.md\`\` file` is present.
| |uncheck| :ref:`The \`\`CONTRIBUTORS.md\`\` file` is present and contains the project lead and main contributors.
| |uncheck| :ref:`The \`\`CODE_OF_CONDUCT.md\`\` file` is present.
| |uncheck| :ref:`The \`\`SECURITY.md\`\` file` is present.

.. card:: |uncheck| The project is compliant with PyAnsys style guidelines.

Expand Down
17 changes: 15 additions & 2 deletions doc/source/how-to/continuous-integration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,27 @@ PyAnsys projects require workflows for performing these types of checks:

- :ref:`Code style <coding_style>`
- :ref:`Documentation style`
- :ref:`Security checks <the check-vulnerabilities action documentation>`
- :ref:`Documentation building <Build documentation>`
- :ref:`Documentation deployment <Deploy documentation>`
- :ref:`Testing`
- :ref:`Test code coverage`
- :ref:`release_publish`

You should collect all workflows in a common ``ci.yml`` file. For more information,
see :ref:`Workflow examples`.
You should collect all workflows in a common ``ci.yml`` file in the ``.github/workflows``
directory. For more information, see :ref:`Workflow examples`.

Dependabot parametrization
--------------------------

PyAnsys projects use Dependabot to keep dependencies up to date.
Dependabot is a GitHub feature that automatically checks for outdated dependencies and creates
pull requests to update them.

Dependabot can be configured to run on different schedules, such as daily, weekly, or monthly.
To configure Dependabot, create a ``dependabot.yml`` file in the ``.github`` directory of your
repository. You can check the `Dependabot cooldown`_ section in :ref:`Repository protection` for
an example of a ``dependabot.yml`` file.

Parametrize workflows
---------------------
Expand Down
Loading