Document min version of git required for usage
sdaconceicao opened this issue · 4 comments
I added the auto-changelog to the workflow in a project I'm working on, and it works great on our modern developer machines. Our CI server though is older and is running git 1.7.1, and after some debugging I found that this is using functionality not available in such an old version. I think just documenting a min version that this requires would be helpful since right now it silently fails to find any commits instead of returning an error about the git commands failing.
v1.7.1 came out over 10 years ago; it could surely be documented, but I don't think it's particularly reasonable to be running a 10 year old version of any easily upgraded software :-)
Not necessarily when you're talking about a server running an ancient os that's currently past support.
Right now the installation doesn't mention needing any version of git. I think it would just be helpful to include a min version which is required, because not every machine will have any of git installed on it. Documenting that would help the next person so they don't have to debug why changelogs were silently failing to generate properly.
Anyone doing development such that they'd need to generate a changelog will certainly have git installed, but it can't hurt to document the minimum.
The minimum git version is already in the readme, as one of only two requirements for using auto-changelog.