Skip to content

Conversation

@caitlynstocker
Copy link
Contributor

@caitlynstocker caitlynstocker commented Dec 12, 2025

Background 🌇

This repository uses release please to coordinate the creation of new versions of the action, based on conventional commit prefixes (e.g. fix for a bug fix that should be released as a new patch version).

It's easy to forget to create a PR with the correct prefix and then do a squash merge with the right commit message. If you do forget you then need to create another PR with the right commit message, total footgun that most people get wrong.

What's this? 🌵

This PR add a workflow to check that a PR title contains a conventional commit message. It runs when a PR is opened/reopened/pushed-to or when the PR title is updated.

The workflow is copied directly from our deprovision-ephemeral-environment action repo where this same check is already in place.

🚩 To make this change more effective, I've also updated the repository to allow only squash merges and take the commit message for a squash merge from the PR title.

How to review? 🔍

☑️ Anything I've missed?

[sc-130123]

@caitlynstocker caitlynstocker requested a review from a team as a code owner December 12, 2025 05:26
@caitlynstocker caitlynstocker changed the title feat: Add workflow to check PR title feat: Add workflow to check for conventional commit format PR title Dec 12, 2025
@caitlynstocker caitlynstocker merged commit 7898d62 into main Dec 12, 2025
12 of 13 checks passed
@caitlynstocker caitlynstocker deleted the cat/130122/check-for-conventional-commits branch December 12, 2025 05:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants