I personally found the changelog for v6 to be very confusing. Yes it clearly explains that the credentials are persisted elsewhere, but it doesn't say where, why, or what I have to change to adopt this breaking (major version) change. Will my git push workflows still work? What if I use a custom ssh-key? Do I need to change my workflows to point to this new file?
It was only after stumbling across and reading this post I finally understood that this is not a breaking change for most workflows, despite the major version bump, and that due to the includeIf directives inserted into the default git config that any bare git commands in my workflows will, in fact, continue to work without any changes. But that is an answer several posts down in a random discussion thread in a completely different part of GitHub. I spent easily over half an hour clicking around in issues and PRs here trying to find any explanation for what this change meant for me before I finally found it.
My request is to clarify the v6 "what's new" to explain that there is no breaking change for most users (aside from those using other platforms [e.g. #2321]) and that if you need to git push later everything will, in fact, still work. Bonus points if you add a "read more" link to the aforementioned discussion comment; double bonus points if you embed that rationale into this repo itself.
I personally found the changelog for v6 to be very confusing. Yes it clearly explains that the credentials are persisted elsewhere, but it doesn't say where, why, or what I have to change to adopt this breaking (major version) change. Will my
git pushworkflows still work? What if I use a customssh-key? Do I need to change my workflows to point to this new file?It was only after stumbling across and reading this post I finally understood that this is not a breaking change for most workflows, despite the major version bump, and that due to the
includeIfdirectives inserted into the default git config that any bare git commands in my workflows will, in fact, continue to work without any changes. But that is an answer several posts down in a random discussion thread in a completely different part of GitHub. I spent easily over half an hour clicking around in issues and PRs here trying to find any explanation for what this change meant for me before I finally found it.My request is to clarify the v6 "what's new" to explain that there is no breaking change for most users (aside from those using other platforms [e.g. #2321]) and that if you need to
git pushlater everything will, in fact, still work. Bonus points if you add a "read more" link to the aforementioned discussion comment; double bonus points if you embed that rationale into this repo itself.