Skip to content
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

Jump to bottom

chore: Update default vale version 3.4.1 #410

Merged
merged 17 commits into from
Apr 16, 2024
Merged

chore: Update default vale version 3.4.1 #410

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
0c58106
Update default vale verison
dipinknair Feb 23, 2024
191d94f
Merge branch 'main' into maint/vale-update
RobPasMue Feb 23, 2024
eabf5e8
Merge remote-tracking branch 'origin/main' into maint/vale-update
dipinknair Feb 23, 2024
d66bccb
Merge branch 'maint/vale-update' of https://github.com/ansys/actions …
dipinknair Feb 23, 2024
2f07fe5
Update migration doc
dipinknair Feb 23, 2024
8a9e0cf
trailing whitespace fix
dipinknair Feb 24, 2024
8477dc3
Update doc-style/action.yml
RobPasMue Mar 14, 2024
16c1fd4
Update doc/source/migration_guide.rst
RobPasMue Mar 14, 2024
e2b7930
Merge branch 'main' of https://github.com/ansys/actions into maint/va…
dipinknair Mar 26, 2024
da68a48
Merge branch 'main' into maint/vale-update
jorgepiloto Apr 11, 2024
73de1be
update latest version
dipinknair Apr 13, 2024
af14e4b
Merge branch 'main' into maint/vale-update
RobPasMue Apr 15, 2024
3dbc10b
update migration
dipinknair Apr 15, 2024
6967e3b
Merge branch 'maint/vale-update' of https://github.com/ansys/actions …
dipinknair Apr 15, 2024
c624c02
update migration guide
dipinknair Apr 15, 2024
f7efa8a
Apply suggestions from code review
dipinknair Apr 16, 2024
e726cb6
remove deprecation warning
dipinknair Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 1 addition & 3 deletions doc-style/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,7 @@ inputs:
vale-version:
description: >
Version number for Vale.
# TODO: use the latest stable version from Vale, see issue
# https://github.com/ansys/actions/issues/350
default: '2.29.6'
default: '3.3.0'
dipinknair marked this conversation as resolved.
Show resolved Hide resolved
required: false
type: string

Expand Down
3 changes: 2 additions & 1 deletion doc/source/migrations/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from one version of the actions to another, and other upstream dependencies that
have been updated.

Development version

Check warning on line 10 in doc/source/migrations/index.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/migrations/index.rst#L10 

[Google.Headings] 'Development version' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Development version' should use sentence-style capitalization.", "location": {"path": "doc/source/migrations/index.rst", "range": {"start": {"line": 10, "column": 1}}}, "severity": "WARNING"}
-------------------

**New features:**
Expand All @@ -21,7 +21,8 @@

**Breaking changes:**

- N/A
- Upgrade default ``vale`` version from ``2.29.6`` to ``3.3.0`` in ``ansys/actions/doc-style`` action.
Vale config file ``.vale.ini`` and ``Vocab/ANSYS`` has to be changed as per `Vale section <https://dev.docs.pyansys.com/doc-style/formatting-tools.html#vale>`_ in PyAnsys developer’s guide

**Migration steps:**
RobPasMue marked this conversation as resolved.
Show resolved Hide resolved

Expand All @@ -34,7 +35,7 @@
**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.

Check warning on line 38 in doc/source/migrations/index.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/migrations/index.rst#L38 

[Google.WordList] Use 'select' instead of 'check'.
Raw output 
{"message": "[Google.WordList] Use 'select' instead of 'check'.", "location": {"path": "doc/source/migrations/index.rst", "range": {"start": {"line": 38, "column": 49}}}, "severity": "WARNING"}
- Added ``ansys/actions/docker-style`` to check for 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.
Expand Down