Changelog#

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#