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: update v6 changes #463

Merged
merged 3 commits into from
Apr 18, 2024
Merged
Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions commit-style/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ inputs:

use-upper-case:
description: >
Use of uppercase letters in the "type" and "scope" fields of the commit.
For example, "FIX(SERVER)!: fix server crash issue" would be a valid commit.
Use of uppercase letters in the "type" field of the commit.
For example, "FIX!: fix server crash issue" would be a valid commit.

.. note::

Expand Down
7 changes: 7 additions & 0 deletions doc/source/migrations/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,13 @@ Version ``v6``
- Generation of `sitemap.xml` file for quicker indexing of `version/stable/` pages
- Inclusion of `canonical` link tags in all HTML files for SEO purposes

- Extend ``ansys/actions/doc-build`` to be able to run in Windows runners.
To buid the documentation in a Windows runner, we install ``Chocolatey`` and ``Miktex``.

- Allow ``ansys/actions/commit-style`` to work with upper case in the type field of a commit.
Expected types are upper cases of `conventional commit types
<https://github.com/commitizen/conventional-commit-types/blob/master/index.json>`_.

**Breaking changes:**

- Upgrade default ``vale`` version from ``2.29.6`` to ``3.4.1`` in ``ansys/actions/doc-style`` action.
Expand Down