Skip to content

Latest commit

 

History

History
405 lines (252 loc) · 31 KB

CHANGELOG.md

File metadata and controls

405 lines (252 loc) · 31 KB
Raw

Changelog

This is an auto-generated log of all the changes that have been made to the project since the first release.

This project adheres to Semantic Versioning.

Unreleased

These are the changes that have been merged to the repository since the last release. If you want to try out these changes, you can install the latest version from the main branch by running:

$ pip install git+https://github.com/seapagan/github-changelog-md

or, if using poetry:

$ poetry add git+https://github.com/seapagan/github-changelog-md

Everything in this section will be included in the next official release.

Refactoring

Full Changelog | Diff | Patch

0.9.4 (June 18, 2024)

Closed Issues

  • The release_text option does not work if the --next-release is specified and corresponds to that release_text version. (#272) by seapagan

Testing

Bug Fixes

  • Don't print the release title if it is the same as the tag (#309) by seapagan
  • Fix missing release text when using --next-release option (#273) by seapagan

Refactoring

Documentation

  • Docs: fix bad README link to installation docs (#307) by seapagan

Dependency Updates

Full Changelog | Diff | Patch

0.9.3 (May 02, 2024)

Dependency Updates

Full Changelog | Diff | Patch

0.9.2 (March 07, 2024)

This release relaxes the version criteria for simple-toml-settings, there are no further changes. Full Changelog | Diff | Patch

0.9.1 (February 27, 2024)

New Features

  • For a closed issue, show the name who closed it not who opened it (#210) by seapagan
  • Stop with error if the config file schema is wrong (#198) by seapagan

Bug Fixes

  • Fix error causing crash if issue is converted to discussion (#216) by seapagan

Dependency Updates

Full Changelog | Diff | Patch

0.8.1 (February 08, 2024)

This release is to fix security issues in some of the project dependencies.

These are: cryptography, jinja2 and gitpython.

Several other dependencies have been updated to their latest versions as well.

Dependency Updates

Full Changelog | Diff | Patch

0.8.0 (November 19, 2023)

New Features

  • Allow totally replacing the text for a specific release (release_overrides option) (#142) by seapagan

Dependency Updates

Full Changelog | Diff | Patch

0.7.2 (November 14, 2023)

Closed Issues

  • If ignored_users is not specified, all users are ignored which results in using the release text instead of the generated changelog (#135) by seapagan

Bug Fixes

  • Fix bug where without ignored_users specified, all users are ignored (#136) by seapagan

Dependency Updates

Full Changelog | Diff | Patch

0.7.1 (November 13, 2023)

Bug Fixes

  • Fix spacing issues caused by extra line when deps are truncated (#133) by seapagan

Documentation

  • Refactor and clarify documentation site (#127) by seapagan

Dependency Updates

Full Changelog | Diff | Patch

0.7.0 (November 08, 2023)

New Features

  • Add an optional text block between releases (#124) by seapagan
  • Implement a release_text option to add arbitrary text to any release (#121) by seapagan
  • Allow marking a release as 'yanked' (or removed) for some reason (#120) by seapagan
  • Add intro_text option to display a block of text at the top of the Changelog (#118) by seapagan
  • Add diff and patch links for each Release (#117) by seapagan
  • Allow to only show max_depends number of dependency updates for each release (#116) by seapagan
  • Implement the ignore_users setting. Users listed in this will not have any PRs or Issues in the Changelog (#115) by seapagan

Bug Fixes

  • Hide custom text from 'unreleased' if we are also using --next-release (#122) by seapagan

Refactoring

  • Add mypy to pre-commit and update tool versions (#119) by seapagan
  • Refactor settings class, change default values (#114) by seapagan

Documentation

  • Refactor the documentation layout, splitting the long documentation section into multiple sections (#123) by seapagan

Dependency Updates

Full Changelog | Diff | Patch

0.6.0 (November 04, 2023)

New Features

  • Make the list of ignored labels customizable (#109) by seapagan
  • Implement renaming default section headers (#108) by seapagan
  • Handle missing release body (#106) by seapagan
  • Hide PRs or Issues by their GitHub number (#105) by seapagan
  • Allow sorting PRs and Issues within each section of a release (#104) by seapagan
  • Implement '--no-issues' flag to hide closed issues from the generated changelog (#102) by seapagan

Refactoring

  • Don't add all settings to auto-generated config file (#103) by seapagan

Full Changelog | Diff | Patch

0.5.1 (November 02, 2023)

This release is a bug-fix for release 0.5.0, which was yanked due to crashing when creating a missing config file.

Closed Issues

  • Crash with TypeError when new config created (#99) by seapagan

Bug Fixes

  • Fix Crash with writing/reading None values (#100) by seapagan

Dependency Updates

Full Changelog | Diff | Patch

0.5.0 (November 01, 2023) [YANKED]

This release has been removed for the following reason and should not be used:

  • Crashes on missing config file, use 0.5.1 or above instead.

New Features

  • Change the default position of custom sections and allow custom position (#94) by seapagan
  • Allow a custom date format (#92) by seapagan
  • Implement custom sections in a release (#91) by seapagan
  • Skip release(s) through CLI option or in settings (#88) by seapagan
  • Implement getting settings from the config file (#87) by seapagan
  • Implement quiet mode (#86) by seapagan
  • Implement creating a CONTRIBUTORS file (#85) by seapagan
  • Add list of ignored labels (#83) by seapagan
  • Add a 'breaking changes' section (#81) by seapagan

Bug Fixes

  • Bug: unreleased section not using date format when --next-release specified (#95) by seapagan
  • Bug - missing GitHub PAT causes crash (#93) by seapagan
  • Label matching should be case insensitive (#84) by seapagan

Refactoring

  • Split requirements file into prod and dev (#82) by seapagan

Documentation

  • Fix bad wording in front page and readme (#79) by seapagan

Dependency Updates

Full Changelog | Diff | Patch

0.4.0 (October 28, 2023)

New Features

  • Don't list any PRs with specific flag in the PR title (#74) by seapagan
  • Allow a custom output file name (#72) by seapagan

Refactoring

  • Use Ruff for import sorting (#77) by seapagan
  • Update simple-toml-settings library to latest (#76) by seapagan

Documentation

  • Change the docs logo and favicon (#73) by seapagan
  • Tweak the contributing info in docs a little (#71) by seapagan

Dependency Updates

Full Changelog | Diff | Patch

0.3.0 (October 25, 2023)

New Features

Refactoring

Documentation

  • Docs: add more badges to docs (#67) by seapagan
  • Clarify some areas in the docs and update linting options, list tasks (#66) by seapagan

Full Changelog | Diff | Patch

0.2.3 (October 24, 2023)

Merged Pull Requests

  • Stop splitting the individual PR/Issue lines (#57) by seapagan
  • Trim PR and Issue titles in changelog (#56) by seapagan

Refactoring

Documentation

  • Docs: fix wrong project links in README and index (#52) by seapagan

Dependency Updates

Full Changelog | Diff | Patch

0.2.2 (October 22, 2023)

Bug Fixes

  • Fix another bug with 'next-release' links (#50) by seapagan

Full Changelog | Diff | Patch

0.2.1 (October 22, 2023)

Merged Pull Requests

Bug Fixes

  • Fix bug in release links when 'next release' is specified (#47) by seapagan

Dependency Updates

Full Changelog | Diff | Patch

0.2.0 (October 21, 2023)

First Public Release

This is the first release of this project that was uploaded to PyPI and released as a stable version.

This changelog was generated using github-changelog-md by Seapagan