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

chore: Add PR title conventional commit format check #985

Merged
merged 2 commits into from
Sep 24, 2022

Conversation

bryantbiggs
Copy link
Contributor

What does this PR do?

  • Add PR title conventional commit format check

Motivation

  • Following the squash and merge pattern, our PR titles become the git commit description which is populated in the GitHub release log. Currently, we don't format our releases for conventional commits, but with this new workflow, we can ensure that PR titles follow conventional commits and better generate both the release name and release notes

Example of conventional commit title:
feat: Add support for 'foo' addon

Example of NOT conventional commit title:
add Support for FOO addon

More

  • Yes, I have tested the PR using my local account setup (Provide any test evidence report under Additional Notes)
  • Yes, I have added a new example under examples to support my PR
  • Yes, I have created another PR for add-ons under add-ons repo (if applicable)
  • Yes, I have updated the docs for this feature
  • Yes, I ran pre-commit run -a with this PR

Note: Not all the PRs require a new example and/or doc page. In general:

  • Use an existing example when possible to demonstrate a new addons usage
  • A new docs page under docs/add-ons/* is required for new a new addon

For Moderators

  • E2E Test successfully complete before merge?

Additional Notes

@bryantbiggs bryantbiggs temporarily deployed to EKS Blueprints Test September 24, 2022 00:39 Inactive
@askulkarni2 askulkarni2 temporarily deployed to EKS Blueprints Test September 24, 2022 16:34 Inactive
@askulkarni2 askulkarni2 merged commit 9ebca8d into main Sep 24, 2022
@askulkarni2 askulkarni2 deleted the chore/semantic-pr-titles branch September 24, 2022 16:41
allamand pushed a commit to allamand/terraform-aws-eks-blueprints that referenced this pull request Dec 15, 2022
Co-authored-by: Apoorva Kulkarni <kuapoorv@amazon.com>
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.

None yet

2 participants