Skip to content

Conversation

c-warren
Copy link
Contributor

@c-warren c-warren commented Sep 26, 2025

Why?

Our existing commit process:

  • doesn't immediately convey when there are breaking changes to the releaser
  • doesn't provide information about how to categorize changes in each release
  • is entirely manual preparing releases
  • doesn't always give "good" information about what is contained within a commit
  • doesn't give a good idea of the risk of a given commit

Furthermore, users have stated that our release notes do not provide easily discernable information about what is in a release, including:

  • if there are breaking changes
  • which features are in a given release
  • why they should upgrade

Adding conventional commits aims to tackle these pieces and make contributing to the repository significantly easier.

This PR adds release please that will automate some of the release process. It relies on conventional commits being used, so will only become valuable once that starts to happen.

How did you test it?

Currently testing.

Potential risks

Adding this GitHub action may have unintended consequences for the commit process, and should be monitored to ensure that it doesn't inhibit merging to the repository.

Release notes

N/A

Documentation Changes

⚠️ TODO

{"type": "refactor", "section": "Code Refactoring"},
{"type": "test", "section": "Tests"},
{"type": "build", "section": "Build System"},
{"type": "ci", "section": "Continuous Integration"}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: I'd maybe just keep feat/fix/perf, I don't know if these other ones add a lot of value

@c-warren
Copy link
Contributor Author

This is waiting until we can update the GitHub settings to allow actions (like release-please) to create PRs/update tags.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants