Skip to content

Commit

Permalink
docs: solve vale warnings (#441)
Browse files Browse the repository at this point in the history
  • Loading branch information
RobPasMue committed Apr 2, 2024
1 parent 5a02dd3 commit 443f578
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
6 changes: 3 additions & 3 deletions doc/source/migrations/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ Version ``v5``

**New features:**

- Added ``ansys/action/check-vulnerabilities`` to check for third party and first party vulnerabilities.
This action uses ``bandit`` and ``safety`` to check for vulnerabilities in the code and dependencies, respectively.
- Added ``ansys/actions/docker-style`` to check for Dockerfile style issues using ``hadolint``.
- Added ``ansys/action/check-vulnerabilities`` to verify third party and first party vulnerabilities.
This action uses ``bandit`` and ``safety`` to detect vulnerabilities in the code and dependencies, respectively.
- Added ``ansys/actions/docker-style`` to detect Dockerfile style issues using ``hadolint``.
- Allow ``vale`` version input in ``ansys/actions/doc-style`` action. By default, ``2.29.6`` is used.
- Allow using the twine ``--skip-existing`` flag in the ``ansys/actions/release-pypi-*`` actions.
- Allow using the ``ansys/actions/doc-build`` action to build documentation using a dedicated requirements file (and
Expand Down
10 changes: 5 additions & 5 deletions doc/source/migrations/pyansys-dashboard-upload.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Uploading vulnerabilities to the PyAnsys Dashboard
==================================================

The PyAnsys Dashboard is a web application that allows PyAnsys repository
The PyAnsys Dashboard is a web app that allows PyAnsys repository
maintainers to upload and view the vulnerabilities in their repository. This
allows maintainers to track the vulnerabilities in their repository and
determine if they are being addressed.
Expand All @@ -19,7 +19,7 @@ action.
https://github.com/ansys-internal/pyansys-dashboard


In order to upload vulnerabilities to the PyAnsys Dashboard, you will need to
In order to upload vulnerabilities to the PyAnsys Dashboard, you need to
configure your workflow as follows:

.. code:: yaml
Expand Down Expand Up @@ -54,9 +54,9 @@ configure your workflow as follows:
pyansys-dashboard-token: ${{ secrets.PYANSYS_DASHBOARD_TOKEN }}
pyansys-dashboard-credentials: ${{ secrets.PYANSYS_DASHBOARD_DB_CREDENTIALS }}
The above workflow will run the vulnerability check on every push and pull
request to the repository. If the push is to the main branch, it will also
upload the vulnerabilities to the PyAnsys Dashboard.
The preceding workflow runs the vulnerability verification on every push and pull
request to the repository. If the push is to the main branch, it also
uploads the vulnerabilities to the PyAnsys Dashboard.

For more information on how to configure the ``ansys/actions/check-vulnerabilities`` action, see the
corresponding section in this documentation at :ref:`pyansys_check_vulnerabilities`.
1 change: 1 addition & 0 deletions doc/styles/Vocab/ANSYS/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ pytest
PyPI
towncrier
TXT
PyAnsys Dashboard

0 comments on commit 443f578

Please sign in to comment.