Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't run release workflow if commitlint fails #3399

Open
brian-smith-tcril opened this issue Jan 28, 2025 · 0 comments
Open

Don't run release workflow if commitlint fails #3399

brian-smith-tcril opened this issue Jan 28, 2025 · 0 comments

Comments

@brian-smith-tcril
Copy link
Contributor

The GH merge UI allows renaming commits when merging PRs via squash or creating a merge commit. The default commit message for a multi commit PR that is squashed is the title of the PR, which means while the commits in the PR may pass commitlint the squashed commit message may not.

That is generally not an issue for squashes as it doesn't trigger a new semantic release.

For merge commits, however, the default message can often be less than ideal ("Merge #NUMBER from /long/branch-name/without-much-meaning"). If that commit message is changed and doesn't follow the merge commit patterns we can get into a very sticky situation where a new release is created but commitlint has failed. This then leads to a complex cleanup process when trying to amend the commit message, as the old commit has already been tagged so semantic release stops making releases for any new merges to the branch.

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

No branches or pull requests

1 participant