Releases: octue/conventional-commits
Releases · octue/conventional-commits
Use 💥 emoji to indicate a breaking change
Fix and improve commit message checker
Contents (#63)
Enhancements
- Allow backticks and brackets at end of commit message
Fixes
- Allow breaking change section to contain the words breaking change
Add whitespace to valid commit header endings
Skip pull request description update if skip indicator in body
Add style section to release notes
Contents (#52)
Enhancements
- Add style section to release notes
Fixes
- Ensure "Other" and "Uncategorised" sections of the release notes are always at the bottom of the notes
Get commits from pull request and remove LAST_PULL_REQUEST stop point option
Summary
Ensure all commits from a pull request are used when compiling release notes.
Contents (#50)
IMPORTANT: There is 1 breaking change.
Enhancements
- Add quotation marks to default valid commit header endings (commit message checker)
Fixes
- Get commits from pull request if provided (release notes compiler)
Refactoring
- BREAKING CHANGE: Remove
LAST_PULL_REQUEST
stop point option (release notes compiler)
Operations
- Stop requiring all git history to be fetched in pull request workflow - this speeds up the workflow, especially for larger repositories
Improve release notes compiler error handling if pull request not found
Contents (#49)
Enhancements
- Add package-level logging
- Raise error if pull request isn't found or is not accessible
Add option to add link to pull request in release notes
Contents
New features
- Add option to add link to pull request in release notes and make this the default behaviour
Testing
- Move release notes compiler CLI tests to separate class
Quality Checklist
- New features are fully tested (No matter how much Coverage Karma you have)
- [v0.2 onward] New features are included in the documentation
Support commit messages with multi-line bodies
Mark breaking changes in generated release notes
Summary
Make the release notes compiler mark categorised commit messages whose bodies include one of the breaking change indicators (BREAKING CHANGE
or BREAKING-CHANGE
) and add a warning to the top of the release notes.
Contents
New features
- Mark breaking changes in release notes
Enhancements
- Use bullet points instead of checkboxes in release notes
Operations
- Enforce newline between third party and first party imports in
isort
config
Quality Checklist
- New features are fully tested (No matter how much Coverage Karma you have)
- [v0.2 onward] New features are included in the documentation