Better handling for GitVersion failure cases #2730
Conversation
GitVersion was failing for our builds this week, but the reason was a mystery until we were able to dig into the GitVersion log file on a failed build. What made this really difficult is the actual error was masked by the GitVersionRunner. The error according to Cake was `Expecting state 'Element'.. Encountered 'Text' with name '', namespace ''.` This is accurate because the `DataContactJsonSerializer` is failing to deserialise what is actually an error message from `gitversion.exe`. However, it is ultimately misleading since the actual error message is masked by this exception. We changed our process to call GitVersion twice: 1. Run GitVersion with `OutputType = GitVersionOutput.BuildServer` so it logs to stdout, including any error messages 2. Run GitVersion with `OutputType = GitVersionOutput.Json` to get the deserialised version information This PR proposes a similar approach, but within the GitVersionRunner itself so others fall into the pit of success. It appears the intent of the code was to run GitVersion twice, but the deserialization exception prevents the intended behaviour. Hope this helps!
|
@michaelnoonan this should improve slightly now that PR GitTools/GitVersion#2161 has merged and released in GitVersion 5.2.1. I certainly wouldn't want to call GitVersion twice, especially with noisy build server log output. I was going to submit a followup PR to Cake that scrapes the |
|
Cool. I'm happy to leave this with you since it's a concrete example of where we ran into trouble. Calling gitversion twice is not terribly appealing, even though it will likely hit the gitversion caches and be reasonably fast. |
|
@michaelnoonan apologies for not getting back to you sooner about this PR. Was there an issue opened for the work in this PR? Our contributing guidelines mention that an issue should be created first. |
|
@michaelnoonan thanks for your contribution 👍 |
|
🎉 This issue has been resolved in version v0.38.0 🎉 The release is available on: Your GitReleaseManager bot 📦🚀 |
GitVersion was failing for our builds this week, but the reason was a mystery until we were able to dig into the GitVersion log file on a failed build. What made this really difficult is the actual error was masked by the GitVersionRunner.
The error according to Cake was
Expecting state 'Element'.. Encountered 'Text' with name '', namespace ''.This is accurate because theDataContactJsonSerializeris failing to deserialise what is actually an error message fromgitversion.exe. However, it is ultimately misleading since the actual error message is masked by this exception.We changed our process to call GitVersion twice:
OutputType = GitVersionOutput.BuildServerso it logs to stdout, including any error messagesOutputType = GitVersionOutput.Jsonto get the deserialised version informationThis PR proposes a similar approach, but within the GitVersionRunner itself so others fall into the pit of success. It appears the intent of the code was to run GitVersion twice, but the deserialization exception prevents the intended behaviour.
Hope this helps!