.. _ref_release_notes:

Release notes
#############

This document contains the release notes for the project.

.. vale off

.. towncrier release notes start

`0.2.0 <https://github.com/ansys/scade-design-rules/releases/tag/v0.2.0>`_ - August 27, 2025
============================================================================================

.. tab-set::


  .. tab-item:: Added

    .. list-table::
        :header-rows: 0
        :widths: auto

        * - feat: technical review
          - `#28 <https://github.com/ansys/scade-design-rules/pull/28>`_

        * - feat: add download button to docs
          - `#31 <https://github.com/ansys/scade-design-rules/pull/31>`_


  .. tab-item:: Documentation

    .. list-table::
        :header-rows: 0
        :widths: auto

        * - chore: update CHANGELOG for v0.1.1
          - `#22 <https://github.com/ansys/scade-design-rules/pull/22>`_

        * - chore: update CHANGELOG for v0.1.2
          - `#27 <https://github.com/ansys/scade-design-rules/pull/27>`_


  .. tab-item:: Test

    .. list-table::
        :header-rows: 0
        :widths: auto

        * - Fix: enhance robustness
          - `#33 <https://github.com/ansys/scade-design-rules/pull/33>`_


  .. tab-item:: Miscellaneous

    .. list-table::
        :header-rows: 0
        :widths: auto

        * - Ci: bump ansys/actions from 9 to 10 in the actions group
          - `#32 <https://github.com/ansys/scade-design-rules/pull/32>`_

        * - Docs: doc review
          - `#34 <https://github.com/ansys/scade-design-rules/pull/34>`_


`0.1.2 <https://github.com/ansys/scade-design-rules/releases/tag/v0.1.2>`_ - March 26, 2025
===========================================================================================

.. tab-set::


  .. tab-item:: Documentation

    .. list-table::
        :header-rows: 0
        :widths: auto

        * - chore: Upgrade the repository configuration
          - `#24 <https://github.com/ansys/scade-design-rules/pull/24>`_


  .. tab-item:: Dependencies

    .. list-table::
        :header-rows: 0
        :widths: auto

        * - build: Bump the dependencies group with 2 updates
          - `#23 <https://github.com/ansys/scade-design-rules/pull/23>`_

        * - build(deps): Bump the dependencies group with 3 updates
          - `#25 <https://github.com/ansys/scade-design-rules/pull/25>`_


  .. tab-item:: Maintenance

    .. list-table::
        :header-rows: 0
        :widths: auto

        * - chore: Enable Python 3.12 and greater
          - `#26 <https://github.com/ansys/scade-design-rules/pull/26>`_


`0.1.1 <https://github.com/ansys/scade-design-rules/releases/tag/v0.1.1>`_ - 2025-02-27
=======================================================================================

Added
^^^^^

- feat: Migration `#1 <https://github.com/ansys/scade-design-rules/pull/1>`_
- feat: Add metrics `#17 <https://github.com/ansys/scade-design-rules/pull/17>`_


Dependencies
^^^^^^^^^^^^

- build: Bump the dependencies group with 3 updates `#3 <https://github.com/ansys/scade-design-rules/pull/3>`_, `#13 <https://github.com/ansys/scade-design-rules/pull/13>`_, `#15 <https://github.com/ansys/scade-design-rules/pull/15>`_, `#20 <https://github.com/ansys/scade-design-rules/pull/20>`_
- build: Bump pytest from 8.0.2 to 8.3.3 `#4 <https://github.com/ansys/scade-design-rules/pull/4>`_
- build: Bump pytest-cov from 5.0.0 to 6.0.0 `#5 <https://github.com/ansys/scade-design-rules/pull/5>`_
- build: Bump ansys-sphinx-theme from 1.2.0 to 1.2.1 in the dependencies group `#9 <https://github.com/ansys/scade-design-rules/pull/9>`_


Documentation
^^^^^^^^^^^^^

- docs: improve rule titles `#11 <https://github.com/ansys/scade-design-rules/pull/11>`_
- ci: Reactivate vale `#18 <https://github.com/ansys/scade-design-rules/pull/18>`_
- docs: rule description improvements `#21 <https://github.com/ansys/scade-design-rules/pull/21>`_


Maintenance
^^^^^^^^^^^

- build(deps): Bump peter-evans/create-or-update-comment from 3 to 4 in the actions group `#2 <https://github.com/ansys/scade-design-rules/pull/2>`_
- ci: Group dependencies to minimize repository management `#7 <https://github.com/ansys/scade-design-rules/pull/7>`_
- build: Bump codecov/codecov-action from 4 to 5 in the actions group `#8 <https://github.com/ansys/scade-design-rules/pull/8>`_
- ci: Enable vale `#10 <https://github.com/ansys/scade-design-rules/pull/10>`_
- ci: Remove the dependency to pr-name `#12 <https://github.com/ansys/scade-design-rules/pull/12>`_


Test
^^^^

- test: Add unit tests for `structure` category `#6 <https://github.com/ansys/scade-design-rules/pull/6>`_
- test: Add unit tests for `readability` category `#14 <https://github.com/ansys/scade-design-rules/pull/14>`_
- test: Update tox settings `#16 <https://github.com/ansys/scade-design-rules/pull/16>`_
- test: Run the examples for assessing model coverage `#19 <https://github.com/ansys/scade-design-rules/pull/19>`_

.. vale on