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

Make commit metadata CI check less annoying #479

Open
casey opened this issue Oct 2, 2020 · 0 comments
Open

Make commit metadata CI check less annoying #479

casey opened this issue Oct 2, 2020 · 0 comments

Comments

@casey
Copy link
Owner

casey commented Oct 2, 2020

Currently, there is a CI check that makes sure that each commit has metadata. This is YAML metadata at the end of the commit that includes the type of the commit. For example: type: documentation.

There is a script that automatically generates a changelog, and it puts an emoji by each commit that represents the type of the commit. So, I wanted to make sure that I didn't forget to annotate commits.

However, this is unusual and, I think, annoying for contributors, who aren't used to this requirement. Also, the check fails if any commit in a string of commits don't have metadata, even though those commits are all going to get squashed together.

One idea is to change this to only check commits which are signed by my key, since I sign all commits with my key before merging, that would make sure that no commits without metadata make it into master.

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

No branches or pull requests

1 participant