Add git submodules support to github linking #1270
Merged
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
tmcw
reviewed
Jul 31, 2019
| const parsed = gitUrlParse(getRemoteOrigin.sync(root)); | ||
| let origin; | ||
| if (git.indexOf(root) === 0) { | ||
| const config = ini.parse( |
There was a problem hiding this comment.
For documentation.js's purposes this probably isn't important, but git configuration is a little different than ini and the underlying parse-git-config module did a find/replace to preprocess it so it would work as an ini.
There was a problem hiding this comment.
Oh, good point! I did have parse-git-config here first, but then I upgraded its version to the latest and everything broke, and I didn't have enough patience to get to the bottom of it, so wrote without a dep instead. Will make sure it doesn't break when submodule name contains dots, and if it is, I'll submit another PR. Thanks!
|
Published in 12.1.0. Thanks @mourner! |
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.
The PR adds support for generating github links when running
documentationon a git submodule (rather than a standalone repo). As an example, this will enable cutting out GL JS docs into its own repo that pullsmapbox-gl-jssource as a submodule.I had to do some refactoring to support this — e.g.
findGitwill now return two values, one pointing to the repo root, and the other one to the.gitfolder, which for a submodule will look likeparent_repo/.git/modules/foorather thanrepo/.git(we can't derive the root from the latter).