Repository navigation
Keep the library's version out of the generated tool docs - #1010
Merged
Merged
Conversation
The viewer is looked for in the NuGet cache under this library's own version first, and WriteFoundTools wrote that path as it was, so diffTools.include.md and docs/diff-tool.md went stale at every release (#1009 caught them up from 20.7.1). The writer now shows that segment as {version}, and the docs change only when the search order does.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follows #1009, which caught the generated tool docs up from 20.7.1 to 20.8.2.
Why they went stale.
FallbackViewerDirectories.NuGetlooks for the viewer under this library's own version in the NuGet cache before the*fallback, andDefinitionsTest.WriteFoundToolswrote that path as it was. So every release bump leftsrc/DiffEngine.Tests/diffTools.include.mdanddocs/diff-tool.mdnaming the previous version until someone ran the tests and committed the result.The change.
WritePathsshows the version segment as{version}, for both separators. The six cache paths (win-x64, osx-x64, linux-x64) now read, for example,%NUGET_PACKAGES%\diffengine\{version}\tools\viewer\win-x64\DiffEngineViewer.exe. Nothing else in either doc changes.Tests. Locally on Windows, a Release build had no errors. DiffEngine.Tests: 2,265 passed, 20 skipped, 3 failed. The failures are
AListenerIsFoundOnItsPortandAListenerIsListedOnEveryPlatform, which assertListenerTable.Enumerated, the .NET fallback built onGetActiveTcpListeners. That call misses listeners on this machine's Windows build (10.0.26300), and CI passes them on main.