Skip to content

Releases: octue/conventional-commits

Use 💥 emoji to indicate a breaking change

13 May 13:23
6524952
Compare
Choose a tag to compare

Contents (#65)

Enhancements

  • Use 💥 emoji to indicate a breaking change in the release notes

Fix and improve commit message checker

03 May 18:11
bea66b0
Compare
Choose a tag to compare

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

21 Feb 11:06
1245b41
Compare
Choose a tag to compare

Contents (#55)

Enhancements

  • Add whitespace to valid commit header endings

Skip pull request description update if skip indicator in body

17 Jan 14:28
40c89f2
Compare
Choose a tag to compare

Contents (#53)

Operations

  • Skip pull request description update if skip indicator in body

Add style section to release notes

13 Jan 11:48
3d08f7a
Compare
Choose a tag to compare

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

16 Nov 15:37
7f05d55
Compare
Choose a tag to compare

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

15 Nov 17:19
eba3411
Compare
Choose a tag to compare

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

01 Nov 16:07
d8daaeb
Compare
Choose a tag to compare

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

13 Oct 14:39
f642d40
Compare
Choose a tag to compare

Contents (#40)

Fixes

  • Support commit messages with multi-line bodies

Mark breaking changes in generated release notes

12 Oct 17:06
be5084a
Compare
Choose a tag to compare

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