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

ci: Workflow to check PR for conventional commit format #123

Merged
merged 1 commit into from
Jun 5, 2024

Conversation

chipkent
Copy link
Collaborator

@chipkent chipkent commented Jun 5, 2024

  • PRs will need to adhere to the conventional commit specification: https://www.conventionalcommits.org/en/v1.0.0/
  • If they do not, a comment will be added to the PR with details about the spec
  • Goal is to automate prettier release notes (e.g. separate Features from Fixes, highlight Breaking Changes). Could potentially be used for automated version bumping as well (which we do in deephaven-plugins, automatically bumping the correct version based on if there are breaking changes (major), features (minor), or fixes only (patch) in the release.
  • Follow up:
    • Add this check to branch protection
    • Use the commit history to automatically generate the changelog. In the deephaven-plugins repo, we use cocogitto, which also automatically bumps the version
    • Recommend to use PR_BODY and PR_TITLE for the default squash_merge_commit_mesage and squash_merge_commit_title

I also noticed that with GitHub's automated release notes, you can actually configure it to use the labels to categorize PRs. That could be useful if there's hesitation to using conventional commits. One advantage of conventional commits is that you can easily handle automatic version bumping (we use cocogitto), which I don't think GitHub can do.

See deephaven/deephaven-core#5528

@chipkent chipkent self-assigned this Jun 5, 2024
@chipkent chipkent merged commit 645e239 into main Jun 5, 2024
8 checks passed
@chipkent chipkent deleted the conventional_commits branch June 5, 2024 17:33
@github-actions github-actions bot locked and limited conversation to collaborators Jun 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants