.. _ref_release_notes: Release notes ############# This document contains the release notes for the project. .. vale off .. towncrier release notes start `0.5.1 `_ - January 17, 2025 =========================================================================================== Fixed ^^^^^ - fix: Update license headers and fix broken tests `#271 `_ - fix: Fix "success" statements being printed and LICENSE file updates `#273 `_ Dependencies ^^^^^^^^^^^^ - build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.2.0 to 1.2.1 `#257 `_ - build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.2.1 to 1.2.2 `#259 `_ - build(deps-dev): bump pytest from 8.3.3 to 8.3.4 `#260 `_ - build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.2.2 to 1.2.3 `#264 `_ - build(deps): bump jinja2 from 3.1.4 to 3.1.5 `#267 `_ - build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.2.3 to 1.2.4 `#268 `_ - build(deps): bump gitpython from 3.1.43 to 3.1.44 `#269 `_ - build(deps-dev): bump sphinx-autodoc-typehints from 2.5.0 to 3.0.0 `#270 `_ Miscellaneous ^^^^^^^^^^^^^ - [pre-commit.ci] pre-commit autoupdate `#272 `_ Maintenance ^^^^^^^^^^^ - chore: Update code for reuse v5.0.2 `#263 `_ - chore: Use `pathlib.Path` instead of `os` in add_license_headers.py `#266 `_ - Update changelog file and fragment files `#275 `_ `0.4.4 `_ - November 07, 2024 ============================================================================================ Fixed ^^^^^ - fix: there is no "owner" of libraries `#233 `_ - fix: LICENSE line endings `#236 `_ - fix: AUTHORS and CONTRIBUTORS.md files `#240 `_ Dependencies ^^^^^^^^^^^^ - build(deps-dev): bump sphinx from 7.4.7 to 8.0.2 `#212 `_ - build(deps-dev): bump numpydoc from 1.7.0 to 1.8.0 `#218 `_ - build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.0.3 to 1.0.5 `#222 `_ - build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.0.5 to 1.0.7 `#223 `_ - build(deps): bump importlib-metadata from 8.2.0 to 8.4.0 `#224 `_ - build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.0.7 to 1.0.8 `#227 `_ - build(deps-dev): bump sphinx-autodoc-typehints from 2.3.0 to 2.4.0 `#228 `_ - build(deps): bump importlib-metadata from 8.4.0 to 8.5.0 `#229 `_ - build(deps-dev): bump pytest from 8.3.2 to 8.3.3 `#230 `_ - build(deps-dev): bump sphinx-autodoc-typehints from 2.4.0 to 2.4.1 `#231 `_ - build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.0.8 to 1.0.11 `#234 `_ - build(deps-dev): bump sphinx-autodoc-typehints from 2.4.1 to 2.4.4 `#235 `_ - build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.0.11 to 1.1.2 `#242 `_ - build(deps-dev): bump sphinx from 8.0.2 to 8.1.3 `#246 `_ - build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.1.2 to 1.1.3 `#247 `_ - build(deps-dev): bump sphinx-autodoc-typehints from 2.4.4 to 2.5.0 `#248 `_ - build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.1.6 to 1.1.7 `#252 `_ - build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.1.7 to 1.2.0 `#255 `_ - build(deps-dev): bump pytest-cov from 5.0.0 to 6.0.0 `#256 `_ Miscellaneous ^^^^^^^^^^^^^ - [pre-commit.ci] pre-commit autoupdate `#221 `_, `#225 `_, `#237 `_, `#245 `_, `#249 `_ - chore: update CONTRIBUTORS.md to match guide lines `#254 `_ Documentation ^^^^^^^^^^^^^ - build(deps-dev): bump ansys-sphinx-theme[autoapi] from 0.16.6 to 1.0.3 `#219 `_ - build(deps-dev): bump sphinx-autodoc-typehints from 2.2.3 to 2.3.0 `#226 `_ - build(deps-dev): bump ansys-sphinx-theme[autoapi] from 1.1.3 to 1.1.6 `#251 `_ Maintenance ^^^^^^^^^^^ - build(deps): bump ansys/actions from 6 to 7 `#220 `_ - CHORE: Add hacktoberfest labels `#241 `_ - build(deps): bump ansys/actions from 7 to 8 `#243 `_ `0.4.3 `_ - August 07, 2024 ========================================================================================== Added ^^^^^ - feat: leverage reuse vcs Git strategy `#217 `_ Maintenance ^^^^^^^^^^^ - [pre-commit.ci] pre-commit autoupdate `#213 `_ `0.4.2 `_ - August 01, 2024 ========================================================================================== Changed ^^^^^^^ - chore: update CHANGELOG for v0.4.1 `#201 `_ - Bump version to v0.4.1 and uncomment tech review hook `#202 `_ - chore: adjust add-license-headers script to work with reuse 4.0.3 `#211 `_ Dependencies ^^^^^^^^^^^^ - build(deps-dev): bump sphinx from 7.4.0 to 7.4.7 `#204 `_ - build(deps-dev): bump pytest from 8.2.2 to 8.3.1 `#206 `_ - build(deps): bump importlib-metadata from 8.0.0 to 8.2.0 `#207 `_ - build(deps-dev): bump pytest from 8.3.1 to 8.3.2 `#208 `_ Miscellaneous ^^^^^^^^^^^^^ - chore: update code base to fix bandit warnings `#209 `_ - [pre-commit.ci] pre-commit autoupdate `#210 `_ `0.4.1 `_ - July 15, 2024 ======================================================================================== Changed ^^^^^^^ - chore: update CHANGELOG for v0.4.0 `#193 `_ Fixed ^^^^^ - Fix semantic versioning check in tech-review hook `#194 `_ Dependencies ^^^^^^^^^^^^ - build(deps): bump sphinx from 7.3.7 to 7.4.0 `#198 `_ Miscellaneous ^^^^^^^^^^^^^ - [pre-commit.ci] pre-commit autoupdate `#196 `_ `0.4.0 `_ - July 01, 2024 ======================================================================================== Added ^^^^^ - feat: technical review hook `#183 `_ Changed ^^^^^^^ - chore: update CHANGELOG for v0.3.2 `#186 `_ Dependencies ^^^^^^^^^^^^ - build(deps): bump importlib-metadata from 7.1.0 to 7.2.1 `#187 `_ - build(deps): bump sphinx-autodoc-typehints from 2.1.1 to 2.2.2 `#188 `_ - build(deps): bump ansys-sphinx-theme[autoapi] from 0.16.5 to 0.16.6 `#189 `_ - build(deps): bump importlib-metadata from 7.2.1 to 8.0.0 `#192 `_ Miscellaneous ^^^^^^^^^^^^^ - [pre-commit.ci] pre-commit autoupdate `#190 `_ `0.3.2 `_ - June 20, 2024 ======================================================================================== Fixed ^^^^^ - fix: add recursive argument and code to add-license-headers `#185 `_ Dependencies ^^^^^^^^^^^^ - build(deps): bump pytest from 8.1.1 to 8.2.0 `#172 `_ - build(deps): bump ansys-sphinx-theme[autoapi] from 0.15.2 to 0.16.0 `#175 `_ - build(deps): bump pytest from 8.2.0 to 8.2.1 `#176 `_ - build(deps): bump ansys-sphinx-theme[autoapi] from 0.16.0 to 0.16.2 `#178 `_ - build(deps): bump ansys-sphinx-theme[autoapi] from 0.16.2 to 0.16.5 `#180 `_ - build(deps): bump pytest from 8.2.1 to 8.2.2 `#181 `_ - build(deps): bump sphinx-autodoc-typehints from 2.1.0 to 2.1.1 `#182 `_ Miscellaneous ^^^^^^^^^^^^^ - [pre-commit.ci] pre-commit autoupdate `#173 `_, `#174 `_, `#177 `_, `#179 `_, `#184 `_ `0.3.1 `_ - April 23, 2024 ========================================================================================= Changed ^^^^^^^ - chore: update CHANGELOG for v0.3.0 `#167 `_ - build(deps): bump ansys/actions from 5 to 6 `#170 `_ Dependencies ^^^^^^^^^^^^ - build(deps): bump sphinx from 7.2.6 to 7.3.7 `#168 `_ - build(deps): bump sphinx-autodoc-typehints from 2.0.1 to 2.1.0 `#169 `_ `0.3.0 `_ - April 18, 2024 ========================================================================================= Added ^^^^^ - feat: add doc-changelog and doc-deploy-changelog actions `#164 `_ Changed ^^^^^^^ - maint: bump reuse to v3.0.2 in add-license-headers `#163 `_ `0.2.9 `_ - February 16, 2024 ============================================================================================ Changed ^^^^^^^ - Pinned all dependencies `0.2.8 `_ - January 17, 2024 =========================================================================================== Fixed ^^^^^ - Add upper limit to reuse dependency `0.2.7 `_ - January 16, 2024 =========================================================================================== Fixed ^^^^^ - Fix pytest python versions and fileinput `#118 `_ Dependencies ^^^^^^^^^^^^ - Bump `gitpython` from 3.1.40 to 3.1.41 `#120 `_ - Bump `ansys-sphinx-theme` from 0.13.0 to 0.13.1 `#121 `_ `0.2.6 `_ - January 11, 2024 =========================================================================================== Added ^^^^^ - Add full header to file if empty `#116 `_ `0.2.5 `_ - January 10, 2024 =========================================================================================== Added ^^^^^ - Added custom argument for the copyright's start year & updated add_hook_changes `#111 `_ `0.2.4 `_ - January 4, 2024 ========================================================================================== Fixed ^^^^^ - Apply hook changes after add-license-headers runs `#108 `_ `0.2.3 `_ - January 2, 2024 ========================================================================================== Changed ^^^^^^^ - Remove python 3.8 and add python 3.12 `#106 `_ - Update year to 2024 in license files `#107 `_ Dependencies ^^^^^^^^^^^^ - `pre-commit` autoupdate `#97 `_, `#99 `_, `#100 `_, `#103 `_ - Bump `actions/labeler` from 4 to 5 `#98 `_ - Bump `ansys/actions` from 4 to 5 `#102 `_ - Bump `pytest` from 7.4.3 to 7.4.4 `#104 `_ `0.2.2 `_ - November 15, 2023 ============================================================================================ Added ^^^^^ - Add headers to tests and examples `#85 `_ - Add typehints to add-license-headers functions `#93 `_ Fixed ^^^^^ - Fix add-license-headers to keep edits from previously run hooks `#88 `_ Changed ^^^^^^^ - Remove dep5 files from repository `#89 `_ - Remove .reuse and LICENSES folders `#95 `_ Dependencies ^^^^^^^^^^^^ - Bump `sphinx-autodoc-typehints` from 1.24.0 to 1.25.2 `#86 `_, `#90 `_ - `pre-commit` autoupdate `#87 `_, `#94 `_ - Bump `ansys-sphinx-theme` from 0.12.4 to 0.12.5 `#91 `_ `0.2.1 `_ - October 31, 2023 =========================================================================================== Added ^^^^^ - Added difference check between original file and updated file `#77 `_ Dependencies ^^^^^^^^^^^^ - `pre-commit` autoupdate `#76 `_ - Bump `ansys-sphinx-theme` from 0.12.3 to 0.12.4 `#80 `_ - Bump `pytest` from 7.4.2 to 7.4.3 `#81 `_ `0.2.0 `_ - October 17, 2023 =========================================================================================== Added ^^^^^ - Added check_license argument `#64 `_ - Run hook on specific directories and files `#65 `_ - Update headers & improve unit tests `#69 `_ - Create assets folder with common REUSE templates `#72 `_ - Run add-license-headers hook serially `#74 `_ Changed ^^^^^^^ - Removed loc argument & passed in committed files `#57 `_ Dependencies ^^^^^^^^^^^^ - Bump `ansys-sphinx-theme` from 0.12.1 to 0.12.2 `#70 `_ - Bump `pre-commit` from v4.4.0 to v4.5.0 `#71 `_ `0.1.3 `_ - September 8, 2023 ============================================================================================ Added ^^^^^ - Create custom flags for add-license-header `#44 `_ Changed ^^^^^^^ - Update descriptions for add-license-headers in README `#40 `_ `0.1.2 `_ - September 5, 2023 ============================================================================================ Dependencies ^^^^^^^^^^^^ - [pre-commit.ci] pre-commit autoupdate `#39 `_ `0.1.1 `_ - September 4, 2023 ============================================================================================ Added ^^^^^ - Directory checks & print statement updates `#34 `_ Dependencies ^^^^^^^^^^^^ - build(deps-dev): bump gitpython from 3.1.32 to 3.1.34 `#35 `_ - build(deps-dev): bump pytest from 7.3.0 to 7.4.1 `#38 `_ - build(deps-dev): bump sphinx from 7.2.4 to 7.2.5 `#37 `_ - build(deps-dev): bump ansys-sphinx-theme from 0.10.4 to 0.10.5 `#36 `_ `0.1.0 `_ - September 1, 2023 ============================================================================================ Added ^^^^^ - Create pre-commit hook to add license header to all files `#7 `_ - Default args in pre-commit-hooks.yaml `#11 `_ - feat: ignore links (temp) `#20 `_ Changed ^^^^^^^ - Update the readme file `#21 `_ - Edits to RST and PY files `#28 `_ Fixed ^^^^^ - Fix add-license-headers for reuse version >=2 `#10 `_ - Fix reuse 2.0 implementation `#17 `_ .. vale on