v0.4.1

v0.4.1 (2024-01-14)

Fix

• fix: remove unnecessary noqa (#54)

• CI has started to complain about this (2387b18)

v0.4.0

v0.4.0 (2023-12-09)

Chore

• chore: refactor tox requirements (#52)

• Put the test deps in requirements-test.txt.
• Put the lint deps in requirements-lint.txt and also include
  requirements-test.txt in it.
• Create a new dev-py312 environment which uses an editable install.
  This will serve as the development environment for VS Code. (d29cb8f)

Documentation

• docs: added notes on evolution uptill Nov 2023 (#51)

documented the new CI/CD pipeline (748e2c8)

Feature

• feat: add commonly used utility fixtures (#53)

• add a new .utils submodule
• add create_temp_dir and create_temp_cwd utility fixtures
• refactor vscode settings
• make mypy strict (9edf0f4)

Style

• style(core): apply new ruff format rules (#50)

ruff has acquired a new format rule where even function definitions with
a single argument that are split across multiple lines should have a
trailing comma after that single argument (ae2c5fc)

v0.3.0

v0.3.0 (2023-12-02)

Ci

• ci: add semantic-pr workflow (#47)

Ensure that the PR title follows semantic commit style
otherwise version bumping won't work because
it looks at the commit titles to figure out if a bump is required and
the category of bump (509ac27)

Feature

• feat: bump version to include deps (#49)

• Need a commit using semantic convention to trigger a bump version to
  pick up the latest change which was to add typing-extension as a dep (9d585d8)

Unknown

• Bump version to incorporate new deps (#48)

feat: bump version to incorporate new deps

• typing-extensions was added as a dependency but was not incorporated
  because the commit didn't have semantic style.
• we have added a github action to validate that can no longer happen
• still need to bump the version to include the new dep (6ba5364)

• Add typing-extensions as dependency (#46)

Used by library to support lower versions of Python (7d2b4a3)

v0.2.4

v0.2.4 (2023-11-13)

Fix

• fix: remove unnecessary fetch-depth config (#45)

• the only component of CI/CD that needs access to the full commit history is
  the version bumping logic (sematnic-release)
• bring the setup-python actions into consistency with each other (16fad96)

v0.2.3

v0.2.3 (2023-11-13)

Ci

• ci: format config (#43)

no functional change just add some whitespace and
remove unnecessary name of the checkout step (40e8fe2)

Fix

• fix: use ruff check and format (#44)

• ci: add ruff (check & format), remove black

• ruff check is fantastic
• ruff format is a drop-in replacement for black (in particular the upcoming preview)
  the only places where ruff disagrees with black I agree with the former

• ci: configure ruff

• select all rules
• disable the 4 rules globally that conflict with ruff format
• disable certain rules on a per-file basis
  • assert is allowed in tests
  • we are using print in the unit tests to track execution

• fix: ruff errors

fix all errors detected by ruff after we turned on nearly all the rules

• ci: configure vscode to use ruff

helps find and fix ruff errors (c1b1526)

v0.2.2

v0.2.2 (2023-11-12)

Fix

• fix: semantic-release committer name (#42)

the switch to the upstream semantic-release action meant that
the committer name changed from semantic-release to github-actions

we explicitly configure the action to use the former name since that is
what is expected by the other publish workflow (480cf2a)

v0.2.1

v0.2.1 (2023-11-12)

Documentation

• docs: update notes (#39)

• remove discussion of SSH Deploy Keys
• add discussion of trusted publisher config in PyPI (efd7599)

Fix

• fix: typo in version workflow (#41)

Typo in the workflow yaml (0f18bbb)

• fix: use upstream semantic-release action (#40)

• ci: refactor build command

use the more popular python -m build instead of pyproject-build
since they are exactly equivalent

• fix: switch to upstream semantic-release action

trying once again with the admin PAT and an explicit skip_build option
since the primary problem with the upstream action was failure to build
but we no longer need to build just to bump and release the new version (75b7cad)

v0.2.0

v0.2.0 (2023-11-12)

Feature

• feat: publish to pypi (#38)

• rename file from deploy.yml to publish.yml since publication is
  the more accurate verb when it comes to Python and PyPI
• add additional config to publish.yml for publising to PyPI if
  publication to TestPyPI succeeds
• remove dead code from pyproject.toml (f8a6cea)

v0.1.10

v0.1.10 (2023-11-12)

Fix

• fix: version bump (#37)

• fix typo in semantic-release config for specifying location of version inside the project
• Add --skip-build since semantic-release does not need to build the project to bump the version
• Remove build specific config from semantic-release (5627ed1)

v0.1.9

v0.1.9 (2023-11-12)

Fix

• fix: deploy condition (#36)

there was a typo in the if condition in the test-release job
the correct context is github.event (singular) (aa58e98)