[FIX] Add branch to docfx to let it generate proper source URLs #26
Conversation
This file contains 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.
Looking at https://github.com/dotnet/docfx/blob/cb7c9c82ca2bab664e22c6047e8147627ca27129/src/Docfx.Common/Git/GitUtility.cs#L20, it seems that docfx doesn't automatically infer the active git branch from its content directory, but rather from currently set environment variables.
This fix makes sure to set the
DOCFX_SOURCE_BRANCH_NAMEto the current branch in the iteration, so source URL's are generated properly in the output metadata.