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

Invalid commit format error message does not describe why it errored #6

Open
mmstick opened this issue Aug 13, 2019 · 7 comments
Open
Labels
bug Something isn't working

Comments

@mmstick
Copy link

mmstick commented Aug 13, 2019

Attempting to run this on https://github.com/pop-os/firmware-manager returns the following error message:

Conventional Commit error: invalid commit format

However, since it does not detail why the format is invalid, I have no idea how to fix it.

@JeanMertz
Copy link
Member

Thanks for the report!

I suspect this is similar to #5 (comment), in which I wrote:

The invalid commit format is definitely a bug. I don't use scopes myself, at least not in smaller projects, but I'm in the process of writing a set of tests (#4) to validate the functionality of Jilu, which will undoubtedly bring this issue to the front.

I'll keep this issue open as I work through adding the test cases, and fix this issue.

As for your specific (non-descriptive, I agree!) error, it is triggered here:

https://github.com/rustic-games/conventional-commit/blob/dbd1eb2dec77fda506008682da2236b5b3444a78/src/lib.rs#L169-L171

I quickly went through your commit history, and noticed a typo in this commit:

pop-os/firmware-manager@34eecaa

The intention was for Jilu to ignore non-semantic commits, not error on them (since you don't want to go rewrite your Git history just to please Jilu), so that's another bug that needs to be solved, for which I'll create a separate issue 👍.

@mmstick
Copy link
Author

mmstick commented Aug 13, 2019

We can revise commit titles and their descriptions of prior commits quite easily with git revise, which is what I did today, so I will go through and make sure everything has colons.

We will be using scopes extensively in our projects, though.

@JeanMertz
Copy link
Member

Thanks for the pointer, I'm going to read that post, but my point was mostly that not everyone is willing to rewrite their Git history in any way.

But if you are, that's of course even better, as that will get you the best experience.

Scopes is definitely something that must be supported though, so no worries, this will be fixed sometime today or tomorrow.

@JeanMertz JeanMertz added the bug Something isn't working label Aug 13, 2019
@mmstick
Copy link
Author

mmstick commented Aug 13, 2019

🎉 I got it working. Unsure if I'll stick with it, but I've patched jilu to expose scopes so that the release changes can be grouped by scope.

@JeanMertz
Copy link
Member

Nice! Looks good. Any particular reason not to stick with it? Would be good to get some insights into what works well and what doesnt.

@JeanMertz
Copy link
Member

Small update: I just pushed 6b79f87, which makes Jilu ignore non-conventional commits.

Proper error handling is still an issue though, so I'm going to leave this issue open for a while longer.

@mmstick
Copy link
Author

mmstick commented Sep 9, 2019

This is great. It's a blocker for use in the Ion shell, and a handful of other projects I maintain.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Development

No branches or pull requests

2 participants