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

Supported API? #187

Open
nedbat opened this issue Apr 13, 2021 · 2 comments
Open

Supported API? #187

nedbat opened this issue Apr 13, 2021 · 2 comments
Labels
enhancement User-facing feature enhancements

Comments

@nedbat
Copy link
Contributor

nedbat commented Apr 13, 2021

I would like to collect metrics about commit message conformance in a large collection of repos (https://github.com/edx). Gitlint looks perfect for the "brains" of the measurement, but I think I need to use it as an API rather than a command-line tool.

Do you have plans for a supported public API to gitlint?

Details: I would like to categorize the commits into three buckets:

  • With a conforming message and a body
  • With a conforming message but no body
  • Without a conforming message

Then I'd like to graph that over time to see how the organization is improving.

@jorisroovers
Copy link
Owner

Thanks for the interest, edx looks cool :)

I have thought about this before and I think the conversation around custom OutputFormatters in #45 is somewhat related as it also can be used to more easily parse gitlint output and integrate it with other tools. Not exactly the same, but potentially less effort to implement and maintain while enabling similar use-cases.

Having said that, I'm heavily time-constraint (#134) and don't see myself working on this in the near future. The best I can suggest for right now to script around it using shell, although I understand that's far from ideal.

@jorisroovers jorisroovers added the enhancement User-facing feature enhancements label Apr 13, 2021
@nedbat
Copy link
Contributor Author

nedbat commented Apr 13, 2021

OK, thanks for the quick reply, that's better than I manage in my own side-project repos!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement User-facing feature enhancements
Projects
None yet
Development

No branches or pull requests

2 participants