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.

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

docs: Add code spell hook changes in vale migration guide #464

Merged
merged 1 commit into from
Apr 18, 2024
Merged
Changes from all commits
Commits
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
18 changes: 17 additions & 1 deletion doc/source/migrations/docs-style-vale-version-update.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ as input for the ``doc-style`` action like below.
token: ${{ secrets.GITHUB_TOKEN }}
vale-version: "3.4.1"

In any of the preceding conditions there are two changes needs to implemented:
In any of the preceding conditions, there are two mandatory changes and one optional (depending on
the repository setup) needs to implemented:

1. Update ``Vocab/ANSYS`` path

Expand All @@ -43,5 +44,20 @@ In any of the preceding conditions there are two changes needs to implemented:
BasedOnStyles = Vale, Google
Vale.Terms = NO

3. Update ``codespell`` hook

If your repository includes a ``codespell`` hook in the ``.pre-commit-config.yaml`` file,
utilizing the ``accept.txt`` file, it necessitates modification to reflect the new path
as provided below.

.. code:: yaml

- repo: https://github.com/codespell-project/codespell
rev: v2.2.6
hooks:
- id: codespell
args: ["--ignore-words", "doc/styles/config/vocabularies/ANSYS/accept.txt"]


Finally, verify that the ``doc-style`` action is functioning correctly with the latest changes applied.
Run the action and ensure that the documentation style checks are performed without any issues.