Release notes#

This document contains the release notes for the project.

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#

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

On this page
Show Source