Skip to content

CHANGELOG.md

Latest commit

 

History

History
1094 lines (592 loc) · 59.3 KB

CHANGELOG.md

File metadata and controls

1094 lines (592 loc) · 59.3 KB

Changelog

0.17.0 (2026-03-26)

Compare the full difference.

Fixes

  • Fix linting errors. b79fea2

  • Fix typo in MissingConfigurationError message and add tests to prevent regression. d3e98b1

  • Fix handling of --no-merges flag based on include_merges config and add corresponding unit test. 106d3e5

New

  • Add support for optional Configuration injection in eval_if_callable for enhanced flexibility. 4c95870

  • Add reset_config function to reset global configuration for testing purposes. 0990d06

  • Add tests for capitalize function and handle empty string edge case in implementation. b558f8a

  • Add test for config overwrite prompt and fix abort handling in CLI. 9d6ce54

Other

Updates

  • Refactor suggest_release_type by extracting _process_commits, _build_report_table, and _write_report for improved modularity and testability; add unit tests for new helper functions. 8c86e67

  • Update git_ops to support customizable configuration injection and refactor tests accordingly. 48735ba

  • Refactor render_changelog to reuse get_default_env and add tests to ensure single call per render. 5c06304

  • Updated GitHub workflows. 4116652

0.16.0 (2025-05-30)

Compare the full difference.

Fixes

  • Fix output variable name in bump-version workflow. afd6d62

    Replaced incorrect occurrences of $GITHUB_OUTPUTS with $GITHUB_OUTPUT to properly set outputs in the workflow. This fixes potential issues with downstream steps relying on these outputs.

New

  • Add Python version check in IndentedLoggerAdapter for type handling. 0fc89d5

  • Add MDFormat action for changelog markdown formatting. cd66f37

  • Add MDFormat action for formatting markdown files. d9c7a01

    • Introduced a new MDFormat dataclass to enable markdown file formatting using mdformat.
    • Updates include reading, formatting, and saving content back to the file.

  • Add mdformat dependency and update uv.lock. 45525cf

    • Included mdformat>=0.7.22 in pyproject.toml.
    • Updated uv.lock to reflect dependency changes and updated metadata.

Other

Updates

  • Improve error handling and test coverage for pipeline actions. 07a1780

    • Added logging for missing action imports; default to noop_func with a warning.
    • Updated noop_func to accept both positional and keyword arguments.
    • Improved Action class error handling when setting action_function.
    • Enhanced CLI tests by organizing them in a class for better structure and readability.
    • Added new unit tests for missing action function fallback.

  • Update workflows to adjust docs preview and publishing steps. 04efac2

    • Added Build and publish docs preview step to publish-docs-preview.yaml.
    • Removed redundant Build and publish docs preview step from publish-docs.yaml.

  • Update README and bumpversion config for changelog versioning. c50bc90

    Added README.md to bumpversion configuration to ensure version updates. Also corrected the changelog action version in README from v1 to v0.

0.15.0 (2025-04-13)

Compare the full difference.

Fixes

  • Fixed workflows. e314026

    • Replaced custom setup-git action with published action
    • fixed docker source in action

  • Fix bug in bump-version-preview.yaml. b3d5106

    The dry-run of bump-my-version requires the CHANGELOG.md to have an 0.15.0 header

  • Fix: bump-version-preview and debugging. a684bcc

  • Fixed docstring rendering. cc9f7eb

  • Fixed bump-version.yaml workflow. 8bdbf11

    • Added contents: write permission for committing and pushing
    • Added missing uv step

New

  • Added release hint debuging report to GitHub action output. 4da1360

  • Add support for generating debug reports in release hints. f045d37

    Introduced a report_path configuration option to write detailed release hint reports to a file. Enhanced logging and report generation, modularized outputs with output_report, and added a CLI option --debug-report to configure the report file path. Adjusted test cases and imports to accommodate changes.

  • Added workflow_call to build_python workflow. 6a83ef0

  • Add concurrency control to GitHub Actions workflows. e29fcee

    Added concurrency groups to "bump-version-preview" and "publish-docs" workflows to prevent overlapping runs. This ensures cleaner and more reliable workflow executions by canceling redundant jobs.

Other

  • [pre-commit.ci] pre-commit autoupdate. 97a227d

    updates: - github.com/astral-sh/ruff-pre-commit: v0.11.3 → v0.11.4

  • Enable manual workflow triggering and add build provenance. bfee4b3

    Added workflow_dispatch to allow manual triggering of the workflow. Included additional permissions and steps to support build provenance attestation via GitHub Actions. This improves the security and flexibility of the build process.

Updates

  • Refactored verbose release hint logging. c5b3001

  • Refactor release hint logic and add indented logger. 529ae78

    Refactored ReleaseRule to return structured results and updated related tests. Introduced IndentedLoggerAdapter for structured, indented logging and integrated it into the change log generation process. Enhanced CLI with verbosity options and improved logging outputs for better traceability.

  • Update release workflows. 692705d

    Now they are callable from the build-python workflow

  • Update build workflow with release jobs and input support. a823f51

    Added optional ref input for workflow_dispatch to support flexible checkouts. Introduced additional jobs for container, GitHub, and PyPI releases, enhancing the release process automation. Adjusted triggers to exclude tag pushes prefixed with 'v'.

0.14.0 (2025-04-03)

Compare the full difference.

Fixes

New

  • Add non-root user and update Dockerfile metadata. a38b154

    Introduced a non-root user with configurable UID and GID for better security and flexibility. Updated Dockerfile metadata to include authors, creation date, license, and improved labeling for compliance with OCI standards.

  • Add ref container tag when triggered by workflow dispatch. 31d24c7

  • Add dependabot config. 670c42b

  • Added workflow_dispatch as a trigger for building containers. cc4c027

  • Added name to build container workflow. 428788f

  • Adds docker building. 4c47587

  • Added moveable version tags for github actions. ee676a9

Other

  • Upgrade GitHub Actions to latest stable versions. 165f157

    Updated actions in workflows to use newer versions, including CodeQL actions (v3), Codecov action (v5), and GitHub release action (v2). This ensures compatibility, access to new features, and improved performance.

  • [pre-commit.ci] pre-commit autoupdate. 410317c

    updates: - github.com/astral-sh/ruff-pre-commit: v0.9.6 → v0.11.2

  • Modularize GitHub workflows and streamline release process. 61bedea

    Reorganized and consolidated workflows for clarity and efficiency. Deprecated unnecessary workflows like bumpversion.yaml and release.yaml, introduced modular workflows (e.g., build-python.yaml, release-pypi.yaml), and ensured consistent dependency and Python setup across jobs. Enhanced documentation and test workflows for better alignment with project needs.

  • Switch to Hatch for build system and update project configuration. f32d026

    • Replaced setuptools with Hatch as the build system, updating related configurations in pyproject.toml.
    • Adjusted license declaration, versioning setup, and package management to align with Hatch's conventions.
    • Included changes to bumpversion workflow for consistency.

  • Fies container tag on workflow_dispatch. 7edaef4

  • [pre-commit.ci] pre-commit autoupdate. 736ddfa

    updates: - github.com/astral-sh/ruff-pre-commit: v0.8.6 → v0.9.6

Updates

  • Rename and simplify action to setup-git. fc64f9b

    Removed Python setup steps to focus solely on Git configuration. Updated Git user email and name setup to dynamically use GitHub actor details for improved accuracy.

  • Rename setup python and git action. 237f460

  • Changes the ocker image used for the action. 5b76d03

  • Modify release hint workflow. 63fca08

  • Refactored the PR workflow. 5c9cc84

  • Update workflows. 01e24e4

    Enhanced the GitTag class docstring for clarity and detailed explanation of attributes. Updated GitHub workflows to remove unnecessary PAT tokens, upgrade dependencies, and streamline configurations for package building and artifact downloading.

0.13.0 (2025-02-16)

Compare the full difference.

New

  • Add GitHub Action details and Python dependency lockfile. bf32a74

    Updated the README to include configuration and usage instructions for the new GitHub Action. Added the uv.lock file to track Python dependencies for reproducible builds. These changes improve documentation and enhance dependency management.

  • Add GitHub Action to generate and update changelog. 93fc1bc

    This commit introduces a new GitHub Action using generate-changelog to automate changelog creation or updates. It includes an action.yml for configuration, an entrypoint.sh script for handling inputs and execution, and a Dockerfile to set up the required environment.

Updates

  • Update github action to use uv. c93a125

  • Refactor release rule matching for paths and grouping. 291b925

    Normalize paths as sequences in the release rule logic, enabling support for multiple path patterns. Refactor tests to improve modularity and readability, ensuring consistency with the updated path handling mechanism. Extend functionality to handle more flexible path and grouping validations.

  • Updated the PR workflow. 738cdb0

  • Refactor dependency groups and update bumpversion config. dbaa2c8

    Renamed [project.optional-dependencies] to [dependency-groups] for clarity and alignment with updated conventions. Added Dockerfile to the bumpversion configuration to ensure version consistency across all relevant files.

0.12.1 (2025-01-11)

Compare the full difference.

Fixes

  • Fix: add encoding="utf-8" in file_processing.py. 4b0eda7

Other

0.12.0 (2024-11-26)

Compare the full difference.

New

  • Added additional files to documentation. 6836603

Updates

  • Changed the documentation generator from Sphinx to MkDocs. 770c70d

0.11.0 (2024-11-24)

Compare the full difference.

Fixes

  • Fixed typo in release hint option. 31ad577

Other

Updates

  • Update Python versions in CI workflow. 4b32198

    Removed support for Python 3.8 and added support for Python 3.13 in the test workflow. This ensures compatibility with the latest Python releases and drops an older version that is now less commonly used.

  • Changed framework from Typer to Click. f08d922

  • Refactored test locations. 06d7a45

0.10.2 (2024-07-23)

Compare the full difference.

Other

0.10.1 (2024-04-06)

Compare the full difference.

Fixes

  • Fixed version hint display triggers. d013300

Other

Updates

  • Updated the makefile and the doc automation. b6da42e

0.10.0 (2023-12-04)

Compare the full difference.

Fixes

  • Fixed bug when in a detatched head state. 1d47e41

  • Fixed the release automation. 2207ed3

  • Fixed test automation. be6e77d

  • Fixed incorrect URLs. 7e87375

New

  • Added --branch-override option. 1f1d68b

    This allows the release hint to use the overridden branch name instead of the current branch

  • Added codecov to Workflows. afd33fd

  • Added changelog parsing for retrieving notes for a specific version. 75bc35d

Other

Updates

  • Updated the github action versions. c353b17

  • Updated pre-commit. ff668af

0.9.2 (2022-10-20)

Compare the full difference.

Fixes

  • Fixed a logic error when generating incremental changelogs. c6781b8

0.9.1 (2022-10-20)

Compare the full difference.

Fixes

  • Fixed the notes including the header. 292a6b2

Other

0.9.0 (2022-08-27)

Compare the full difference.

Fixes

  • Fixed a typing error that impacted tests. 4de2cf7

  • Fixed typing issues raised by mypy. 7479bb0

New

  • Added ability to use the current branch in release hint rules. 0965dec

Other

0.8.0 (2022-07-29)

Compare the full difference.

Fixes

  • Fixed the return values of several actions. f679d62

    • stdout now returns the input string
    • IncrementalFileInsert now returns the input string

New

  • Added release hinting functionality to CLI. 49eccc7

  • Added release hinting for commits. ae4ade8

  • Added ability to specify starting tag on the CLI. ca4928e

  • Added file processing action docs. 17123a4

  • Added diff linking and bump2version docs. 6178d2d

  • Added group_by configuration docs. 637a91e

  • Added typing_extensions requirement. 8abd74a

  • Added action to publish documentation on tagging. 30c8deb

Other

Updates

  • Updated the readme. 9739ffb

  • Updated the documentation for release hinting. 2302a26

  • Refactored how the user config and output. 84b54f9

    • Added new method for getting the user config
    • Added generic output method that is aware of if output should be generated based on the -o flag

  • Updated docs. 1bd0f12

  • Removed unused configuration setting. 70a6d27

    • release_hint_default ended up not being used

  • Refactored templating to accept a version context. 094fa94

  • Refactored commit tests into new file. d21c035

  • Renamed render to render_changelog for clarity. 357ba9a

  • Refactored commit processing to its own module. e285ea5

    • All commit processing moved from the templating module to the commits module.

  • Refactored a dict into a dataclass. 81c54de

    • get_commits_by_tag now returns a list of GitTag objects

  • Updated conventional commit docs. af237cd

  • Updated template docs. ece7da5

  • Renamed publish-docs workflow. 549703b

0.7.6 (2022-05-25)

Compare the full difference.

Fixes

  • Fixes packaging. Now includes the templates!. e298c03

0.7.5 (2022-05-24)

Compare the full difference.

Updates

0.7.4 (2022-05-24)

Compare the full difference.

Fixes

Updates

  • Updated setup.cfg. fca1d10

    • Replaces ...HEAD with appropriate version
    • Sets the minimum required version of Python to 3.7
    • Improved package discovery

0.7.3 (2022-05-24)

Compare the full difference.

Fixes

  • Fixes a bug when generating an incremental changelog. 7cc3c16

0.7.2 (2022-05-24)

Compare the full difference.

Updates

  • Updates the publish package workflow again. 4434571

0.7.1 (2022-05-24)

Compare the full difference.

Fixes

  • Fixes the publish package workflow. 26743f0

0.7.0 (2022-05-24)

Compare the full difference.

New

  • Added Python 3.7 compatibility. 263c3d6

  • Added existence check for configuration file during generation. 9e00e1c

    • Asks if you want to overwrite existing configuration

  • Added tests for command line interface. 12837b6

  • Added tests for conventional commits. 6bac10b

  • Added tests for matching and metadata. 7dac045

  • Added conventional commit actions. 34615cd

    • ParseConventionalCommit
    • ParseBreakingChangeFooter

Other

  • Reformatted the changelog output. b7d0f61

    • Updated tests to use new contexts. b222e96

Updates

  • Updated documentation. ec5dc40

  • Refactored the template contexts. c5fbf68

    • Changed GroupedCommit to GroupingContext
    • Added ChangelogContext as a root context for templates.

  • Removed the lazy objects. abd0c96

  • Removed the lazy objects. 75b2d35

  • Updated write_default_config to write comments. 60e66cd

  • Updated configuration. 3c288d2

    • added rendered_variables property
    • added a default variable
    • updated docstrings
    • added default template directory

  • Updated changelog configuration. 92d0a43

  • Updated the rendering for new grouping method. 16dd292

    • Added resolve_name and diff_index utility methods
    • refactored the get_context_from_tags function
    • added diff_index function to template context
    • added group_depth variable to template context
    • refactored first_matching to use the commit_classifiers
    • Updated the versions.md.jinja, section_heading.md.jinja, and commit.md.jinja templates

  • Changed the template contexts. 71d4e01

    • CommitContext now has a grouping tuple
    • Replaced SectionContext with GroupedCommmit
    • Replaced VersionContext.sections with VersionContext.grouped_commits

  • Changed method of grouping commits within versions. 78d9813

    • added group_by to configuration
    • added commit_classifiers to configuration
    • added SummaryRegexMatch as a commit classifier to emulate previous functionality
    • added MetadataMatch to use commit metadata to assign to groups

0.6.1 (2022-05-02)

Compare the full difference.

Fixes

0.6.0 (2022-05-02)

Compare the full difference.

Fixes

  • Fixed Makefile. 1fa22f9

  • Fixed configuraation import. 23d437b

  • Fixed Python 3.10 spec in workflows. cacd9e2

  • Fixed primary branch name in workflows. 94e4203

New

  • Added Github Action CI configs. 4737ce8

  • Added a test for cross-branch tags. b5a523c

Other

Updates

  • Updated release script. 44d1b93

  • Updated documentation. 9b56b4a

  • Changed pre-commit to exclude tests. 0f9e56d

  • Changed and standardized to term 'summary'. 2bd7634

  • Refactored context into new module. 5b1e921

  • Removed variable start string difference from pipeline env. 5dc5903

    • Didn't make sense to have a different method of specifying variables in the pipeline from the default.

0.5.0 (2022-03-15)

Compare the full difference.

New

  • Added a minimal readme. 8ba2ec1

  • Added issue parsing actions. 95e0e35

    • ParseIssue: base class and generic issue parser
    • ParseGitHubIssue: parse GitHub issue patterns
    • ParseJiraIssue: parse Jira issue patterns
    • ParseAzureBoardIssue: parse Azure board issue patterns

  • Added initial documentation for actions. 14ba3be

Updates

  • Renamed processors module to actions. 99284e3

0.4.0 (2022-03-13)

Compare the full difference.

Fixes

  • Fixed missing variables in render context. 0bed08e

New

  • Added support for __contains__ in registry. 848421d

  • Added action registry. a363c25

    • Accessing the registry ensures the built-in actions are loaded.

  • Added changelog configuration and templates. 32f4f23

  • Added a previous_tag attribute to the version context. 5760576

  • Added lazy evaluation of Jinja environments. f57d007

    • This allows for proper setup of the configuration.

  • Added accessor for current configuration. 83a728f

    • get_config() will instantiate a new configuration or return the existing configuration.

Updates

  • Updated processors doc strings. 9102ec7

  • Updated configuration doc strings. ff818af

  • Updated data_merge doc strings. 2840242

  • Updated git_ops and lazy doc strings. 26ecd54

  • Updated pipeline doc strings. 2a2c052

  • Updated templating doc strings. b942302

  • Updated utility doc strings. a7ae93f

  • Removed ActionSpec. 29942ac

    • It was unnecessary. Now Action classes are instantiated directly.

  • Removed author rendering from commits. e44de67

0.3.0 (2022-03-05)

Compare the full difference.

Updates

  • Changed the package name to generate_changelog. 1e4945a

  • Change the configuration file base name to .changelog-config. ac3fc2e

0.2.0 (2022-03-05)

Compare the full difference.

Fixes

  • Fixed the merge handling in git_ops. e9666f5

  • Fixed the include_merges setting. cf6c4f2

    Wasn't hooked up with the git_ops module.

  • Fixed a bug in the capitalize action. 8fee744

    Used to capitalize the first letter but also convert all other characters to lowercase.

New

  • Added release tooling in a Makefile. 8064d3d

  • Added Slice and FirstRegExMatchPosition actions. 19cf66e

    • Slice will slice the input text when called
    • FirstRegExMatchPosition will return the position of the first match of the regular expression.

  • Added IncrementalFileInsert action. d40ba36

    Simplifies incremental change log generation for the output action.

  • Added create_if_missing option to ReadFile. 8d1eaef

    Allows for the creation of an empty file when trying to read from a non-existent file.

  • Added MIT license and entry point config for CLI. 579134b

Other

  • Moved VALID_AUTHOR_TOKENS from templating to configuration. dc93fc3

Updates

  • Updated command line interface. d8abd8d

  • Updated configuration. a8ded3f

    • Fixed DEFAULT_IGNORE_PATTERNS with commas
    • Updated DEFAULT_STARTING_TAG_PIPELINE with better pattern
    • Added chg to ``DEFAULT_SECTION_PATTERNS`
    • Added DEFAULT_OUTPUT_PIPELINE for incremental changes
    • Added valid_author_tokens to configuration

  • Updated tests for pipelines. e280fb8

  • Updates the commit template and rendering. e76fd3a

  • Updated eval_if_callable. ebab2cf

    • Will now instantiate actions or pipelines and run them.

  • Renamed GetFirstRegExMatch to FirstRegExMatch. 82b907f

0.1.0 (2022-03-01)

Compare the full difference.

Other
⚡