CHANGELOG
v0.2.0-rc.3 (2025-06-20)
Build System
Bumps pydantic from 2.11.3 to 2.11.5. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: pydantic dependency-version: 2.11.5
dependency-type: direct:production
update-type: version-update:semver-patch ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps requests from 2.32.3 to 2.32.4. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: requests dependency-version: 2.32.4
dependency-type: direct:production
update-type: version-update:semver-patch ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps typer from 0.15.2 to 0.16.0. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: typer dependency-version: 0.16.0
dependency-type: direct:production
update-type: version-update:semver-minor ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps mkdocs-material from 9.6.12 to 9.6.14. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: mkdocs-material dependency-version: 9.6.14
dependency-type: direct:development
update-type: version-update:semver-patch ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps mkdocstrings-python from 1.16.10 to 1.16.12. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: mkdocstrings-python dependency-version: 1.16.12
dependency-type: direct:development
update-type: version-update:semver-patch ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps python-semantic-release from 9.21.0 to 9.21.1. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: python-semantic-release dependency-version: 9.21.1
dependency-type: direct:development
update-type: version-update:semver-patch ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Chores
-
Updated platformdirs from 4.3.6 to 4.3.7 - Updated typing-extensions from 4.12.2 to 4.13.1 - Updated filelock from 3.17.0 to 3.18.0 - Updated mkdocs-autorefs from 1.4.0 to 1.4.1 - Updated pydantic-core from 2.27.2 to 2.33.1 - Installed typing-inspection 0.4.0 - Updated click-option-group from 0.5.6 to 0.5.7 - Updated griffe from 1.6.0 to 1.7.2 - Updated identify from 2.6.8 to 2.6.9 - Updated mkdocstrings from 0.28.2 to 0.29.1 - Updated pydantic from 2.10.6 to 2.11.3 - Updated virtualenv from 20.29.3 to 20.30.0 - Updated mkdocs-literate-nav from 0.6.1 to 0.6.2 - Updated mkdocs-material from 9.6.7 to 9.6.11 - Updated mkdocs-section-index from 0.3.9 to 0.3.10 - Updated mkdocstrings-python from 1.16.2 to 1.16.10 - Updated pre-commit from 4.1.0 to 4.2.0 - Updated python-dotenv from 1.0.1 to 1.1.0 - Updated setuptools from 75.8.2 to 75.9.1 - Updated types-requests from 2.32.0.20250306 to 2.32.0.20250328
-
Updated markdown from 3.7 to 3.8 - Updated packaging from 24.2 to 25.0 - Updated urllib3 from 2.3.0 to 2.4.0 - Updated typing-extensions from 4.13.1 to 4.13.2 - Updated beautifulsoup4 from 4.13.3 to 4.13.4 - Updated identify from 2.6.9 to 2.6.10 - Updated mkdocs-material from 9.6.11 to 9.6.12
Features
- cli: Pass output-dir, template-file and config-file as named parameters rather than argument
(#115,
41712bb)
Refactors the CLI interface to treat output-dir, template-file, and config-file as named options instead of positional arguments.
- Swapped typer.Argument for typer.Option on output_dir, template_file, and config_file in generate(). - Updated the README’s CLI reference to list the new options and their defaults.
v0.2.0-rc.2 (2025-04-08)
Bug Fixes
-
core: Resolve some minor issues (
5cf1c40) -
leading underscores & asterisks in text elements are no longer escaped
-
inline code statements (exported as elements) are transformed for proper markdown highlighting
Build System
Bumps python-semantic-release/publish-action from 9.16.1 to 9.19.1. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: python-semantic-release/publish-action dependency-type: direct:production
update-type: version-update:semver-minor ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps python-semantic-release/publish-action from 9.19.1 to 9.21.0. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: python-semantic-release/publish-action dependency-type: direct:production
update-type: version-update:semver-minor ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps python-semantic-release/python-semantic-release from 9.16.1 to 9.19.1. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: python-semantic-release/python-semantic-release dependency-type: direct:production
update-type: version-update:semver-minor ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps python-semantic-release/python-semantic-release from 9.19.1 to 9.21.0. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: python-semantic-release/python-semantic-release dependency-type: direct:production
update-type: version-update:semver-minor ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps mkdocs-material from 9.6.3 to 9.6.4. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:development
update-type: version-update:semver-patch ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps mkdocstrings-python from 1.14.6 to 1.15.0. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: mkdocstrings-python dependency-type: direct:development
update-type: version-update:semver-minor ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps python-semantic-release from 9.18.1 to 9.19.1. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: python-semantic-release dependency-type: direct:development
update-type: version-update:semver-minor ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Chores
v0.2.0-rc.1 (2025-02-04)
Build System
Bumps pydantic from 2.10.4 to 2.10.6. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: pydantic dependency-type: direct:production
update-type: version-update:semver-patch ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps python-semantic-release/publish-action from 9.15.2 to 9.16.1. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: python-semantic-release/publish-action dependency-type: direct:production
update-type: version-update:semver-minor ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps python-semantic-release/python-semantic-release from 9.15.2 to 9.16.1. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: python-semantic-release/python-semantic-release dependency-type: direct:production
update-type: version-update:semver-minor ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps mkdocs-material from 9.5.49 to 9.5.50. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:development
update-type: version-update:semver-patch ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Features
- core: Export ticket type
(
50a376e)
v0.1.2 (2025-01-05)
Chores
v0.1.2-rc.1 (2025-01-05)
Bug Fixes
- libs: Enable handling of checkbox fields
(
7e79935)
Build System
Bumps jinja2 from 3.1.4 to 3.1.5. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: jinja2 dependency-type: direct:production
update-type: version-update:semver-patch ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps pydantic from 2.10.3 to 2.10.4. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: pydantic dependency-type: direct:production
update-type: version-update:semver-patch ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps mkdocstrings-python from 1.12.2 to 1.13.0. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: mkdocstrings-python dependency-type: direct:development
update-type: version-update:semver-minor ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Chores
v0.1.1 (2024-12-18)
Build System
Bumps actions/checkout from 3 to 4. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production
update-type: version-update:semver-major ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps actions/setup-python from 4 to 5. - Release notes - Commits
--- updated-dependencies: - dependency-name: actions/setup-python dependency-type: direct:production
update-type: version-update:semver-major ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Bumps mkdocs-material from 9.5.48 to 9.5.49. - Release notes - Changelog - Commits
--- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:development
update-type: version-update:semver-patch ...
Signed-off-by: dependabot[bot] support@github.com
Co-authored-by: dependabot[bot] 49699333+dependabot[bot]@users.noreply.github.com
Chores
- Merge 'develop' into 'main'
(
faf31aa)
v0.1.1-rc.1 (2024-12-17)
Bug Fixes
- docs: Resolve MkDocs issue
(
2c1232f)
Build System
- Configure remote token for python-semantic-release
(
622e60c)
Chores
- Merge branch 'main' into develop
(
3f12a5b)
v0.1.0 (2024-12-17)
Chores
- Merge 'develop' into 'main' #7
(
b3b8d52)
v0.1.0-rc.1 (2024-12-17)
Bug Fixes
Build System
-
Fetch entire repo history in release pipeline (
1f048f7) -
Give pipeline id-token permission (
8c60510) -
Give release pipeline write permissions (
0ab7065) -
build: init repo
-
build: Typer app
-
Integrate python-semantic-release #6 (
7677b9c) -
Remove repo_dir from semantic_release config (
b2a2114) -
Resolve branch trigger typo (
2c671a9) -
Resolve python-semantic-release issue (
8e385e2) -
docs: Mkdocs integration incl. GH workflow (
ba95c1e) -
build: MkDocs config + pipeliine
-
ci: Enable manual trigger for docs. build pipeline
Documentation
-
Extend docs (
87dabee) -
docs: include GIF of CLI usage
-
build: update link to README in pyproject.toml
Features
-
core: Provide main function (
d22c458) -
checkpoint: retrieve issues from Jira
-
checkpoint: export release notes via Jinja template
-
checkpoint: convert all rendered fields to Markdown
-
checkpoint: switch to markdownify for proper nested lists
-
refactor: move core function into core module
-
checkpoint: integrate generate command to CLI
-
refactor: remove leftovers, add docs