search

rustic-games / jilu

Generate a change log based on the state of your Git repository.
104 stars 6 forks source link

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

Open mmstick opened 5 years ago

mmstick commented 5 years ago

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 commented 5 years ago

Thanks for the report!

I suspect this is similar to https://github.com/rustic-games/jilu/issues/5#issuecomment-520815076, 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:

https://github.com/pop-os/firmware-manager/commit/34eecaab54fd415c64711dba44ed2500db63dd62

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 commented 5 years ago

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 commented 5 years ago

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.

mmstick commented 5 years ago

:tada: 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 commented 5 years ago

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 commented 5 years ago

Small update: I just pushed 6b79f8725ed99db07c5199428d8b70cf35bc9eb2, 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 commented 5 years ago

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