chore: Update default vale version 3.4.1

doc-style/action.yml

@@ -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.4.1'
     required: false
     type: string
 
@@ -73,36 +71,6 @@ runs:
       uses: actions/checkout@v4
       if: inputs.checkout == 'true'
 
-    # TODO: remove this deprecation in ansys/actions@v6
-
-    - name: "Build deprecation warning"
-      if: startswith(inputs.vale-version, '2.')
-      shell: bash
-      run: |
-        deprecation_text="
-        Ansys Actions v6 will include by default Vale version v3. For
-        migrating, please update your 'doc/.vale.ini' file and 'doc/styles'
-        directory as in this pull-request https://github.com/ansys/pymechanical/pull/613
-        "
-        echo "DEPRECATION_TEXT=$(echo $deprecation_text)" >> $GITHUB_ENV
-
-    - uses: ansys/actions/_logging@main
-      if: startswith(inputs.vale-version, '2.')
-      with:
-        level: "WARNING"
-        message: >
-          Ansys Actions v6 will include by default Vale version v3. For
-          migrating, please update your "doc/.vale.ini" file and "doc/styles"
-          directory as in this pull-request https://github.com/ansys/pymechanical/pull/613
-
-    - name: "Raise deprecation warning outside of the CI/CD logs"
-      shell: bash
-      if: startswith(inputs.vale-version, '2.')
-      run: |
-        echo "::warning ::${DEPRECATION_TEXT}"
-
-    # TODO: end
-
     - name: "Run Vale"
       uses: errata-ai/vale-action@reviewdog
       env:

doc/source/migrations/docs-style-vale-version-update.rst

@@ -0,0 +1,48 @@
+.. _docs_style_vale_update:
+
+Doc-style action - migrating from Vale ``2.X`` to ``3.X``
+=========================================================
+
+When migrating ``ansys/actions/doc-style`` from ``v5`` to higher versions, the default Vale version is upgraded to ``v3``.
+Certain changes must be made to the repository to ensure that the ``doc-style`` action performs without issues.
+Additionally, it is possible to use ``ansys/actions`` older than ``v5`` while utilizing Vale ``v3``
+as input for the ``doc-style`` action like below.
+
+.. code:: yaml
+
+    doc-style:
+        name: Documentation Style Check
+        runs-on: ubuntu-latest
+        steps:
+        - name: PyAnsys documentation style checks
+            uses: ansys/actions/doc-style@v5
+            with:
+            token: ${{ secrets.GITHUB_TOKEN }}
+            vale-version: "3.4.1"
+
+In any of the preceding conditions there are two changes needs to implemented:
+
+1. Update ``Vocab/ANSYS`` path
+
+   In order to comply with the requirements of Vale ``v3``, it is necessary to update the vocabularies
+   path under the ``doc/styles`` directory. Specifically, the default vocabularies path should be modified from
+   ``Vocab/ANSYS`` to ``config/vocabularies/ANSYS``. This adjustment ensures that Vale can locate the required vocabulary files.
+
+   .. note:: Update ``.gitignore``
+
+      If your repository has ``.gitignore`` files under ``styles`` folder, please update them according to vocabularies changes
+
+2. Turn off ``Vale.Terms``
+
+   Locate the section in your ``doc/.vale.ini`` file where styles are applied.
+   Add ``Vale.Terms = NO`` under the section where styles are applied, typically marked with ``[*.{rst}]``.
+
+   .. code:: ini
+
+      [*.{rst}]
+      BasedOnStyles = Vale, Google
+      Vale.Terms = NO
+
+
+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.

doc/source/migrations/index.rst

@@ -7,7 +7,7 @@
 from one version of the actions to another, and other upstream dependencies that
 have been updated.
 
 Development version
 -------------------
 
 **New features:**
@@ -22,12 +22,14 @@
 
 **Breaking changes:**
 
-- N/A
+- Upgrade default ``vale`` version from ``2.29.6`` to ``3.4.1`` in ``ansys/actions/doc-style`` action.
+- Vale configuration file ``.vale.ini`` and ``Vocab/ANSYS`` has to be changed.
 
 **Migration steps:**
 
 - To set up your repository to use the ``ansys/actions/doc-changelog`` action, see the :ref:`docs_changelog_action_setup`.
 - To set up your repository to use the ``ansys/actions/doc-deploy-changelog`` action, see the :ref:`docs_deploy_changelog_action_setup`.
+- To set up your repository to use the ``ansys/actions/doc-style`` action, see the :ref:`docs_style_vale_update`.
 
 Version ``v5``
 --------------
@@ -84,3 +86,4 @@
 
    docs-changelog-setup
    docs-deploy-changelog-setup
+   docs-style-vale-version-update