Contents (#82)

IMPORTANT: There is 1 breaking change.

Enhancements

• 💥 BREAKING CHANGE: Remove deprecated scripts
• Ignore header line length limit for MRG commits

Operations

• Use latest semantic version checker, pull request description generator, and commit message checker

Upgrade instructions

Contents (#79)

Fixes

• Align ConventionalCommitMessageChecker class defaults with CLI defaults

Summary

Move the semantic version checker to the new octue/check-semantic-version repo where it can be used as a GitHub action. It's also still available the old way, but support for this will be remove at some point.

Contents (#78)

IMPORTANT: There is 1 breaking change.

Fixes

• Update default argument for commit body line length in commit message checker

Operations

• Update workflows

Refactoring

• 💥 BREAKING CHANGE: Move check-semantic-version GHA to its own repository
• Add deprecation warnings for old python modules

Upgrade instructions

Summary

Move the release notes compiler to the new octue/generate-pull-request-description repo where it can be used as a GitHub action. It's also still available the old way, but support for this will be remove at some point.

Contents (#77)

Refactoring

• Move release notes compiler to https://github.com/octue/generate-pull-request-description

Fixes

• Fix installation of package in Dockerfile

Operations

• Avoid running python-ci workflow on main branch
• Ignore Codecov failure when releasing
• Fix context for check-semantic-version docker image builds
• Remove unnecessary setup-python steps in workflows
• Use new generate-release-notes GHA in update-pull-request workflow
• Use latest version of checkout GHA in workflows

Summary

Add a GitHub action utilising the check-semantic-version CLI that can be easily used in GitHub workflows.

Contents (#76)

New features

• Add check-semantic-version GitHub action

Operations

• Use latest setup-python action in workflows
• Use check-semantic-version GitHub action in python-ci workflow
• Add build-docker-image workflow
• Add testing and docker build/push to release workflow

Other

• Update example workflow with check-semantic-version GHA

Summary

Allow long lines in commit message bodies by default to allow easier markdown editing in breaking change sections of commit messages.

Contents (#75)

Fixes

• Increase default maximum commit body length to 10000

Contents (#73)

Fixes

• Ensure all commits in a PR are used in the release notes generator

Style

• Use latest commit message checker

Contents (#72)

Fixes

• Update compile-release-notes CLI default header option

Contents (#70)

Enhancements

• Use collapsible sections in upgrade section and add breaking change emoji to denote each section
• Put upgrade instructions at bottom of release notes
• Move breaking change warning to contents section
• Add horizontal rule between contents and upgrade instructions
• Use H1 for contents and upgrade instructions headers

Refactoring

• Factor out contents section creation into method

Summary

Include the commit bodies for breaking change commits in the release notes in a new upgrade instructions section so developers can see how to upgrade their code around breaking changes.

Contents (#66)

New features

• Include breaking change update instructions in release notes