internal error: entered unreachable code about changelog HOT 6 CLOSED

Sure! I'll try to take a look in the next few days

from changelog.

Whooops, looks like some of our traversal logic might have gone wrong, most likely somewhere here: https://github.com/yoshuawuyts/changelog/blob/master/src/git.rs#L78-L114.

@danreeves would you perhaps like to try and fix this?

from changelog.

@danreeves awesome! -- happy to help if you have any questions! ✨

from changelog.

Spent a little time investigating this morning and found two situations where the logic breaks down.

1. Lightweight tags

Created with git tag [name], a lightweight tag doesn't have it's own object, it just points to a commit.

2. Having a single (annotated) tag

In the case where you've only got a single tag the the end will be a commit object rather than a tag.

For example:

"Expected" output of get_commit_range:

start: Object { kind: Tag, id: ... } 
end: Object { kind: Tag, id: ... }

Output in case 1:

start: Object { kind: Commit, id: ... } 
end: Object { kind: Commit, id: ... }

Output in case 2:

start: Object { kind: Tag, id: ... } 
end: Object { kind: Commit, id: ... }

Solution

Unfortunately you can't just .as_tag() a commit object in the case of lightweight tags, and that wouldn't work in the case where an end tag doesn't even exist. Perhaps it might make sense to return something like this from get_commit_range:

struct CommitRange {
	latest_tag: Tag,
	start: git2::Commit,
	end: git2::Commit,
}

How does that sound?

from changelog.

@danreeves that sounds like a very reasonable solution; I like it!

from changelog.

Resolved by #13

from changelog.