Fix Github Wiki Page Links #4538
Conversation
pkg/giturl/giturl.go
Outdated
| if line > 0 { | ||
| baseLink += "#L" + strconv.FormatInt(line, 10) | ||
| } | ||
|
|
There was a problem hiding this comment.
I know I'm being persnickety but this newline is bugging me :/
pkg/giturl/giturl.go
Outdated
| // GitHub Wiki links are formatted differently | ||
| baseLink = repo[:len(repo)-9] + "/wiki/" | ||
| if file != "" { | ||
| baseLink += strings.TrimSuffix(file, ".md") + "/" |
There was a problem hiding this comment.
This assumes that if file is empty, the actual file we care about is a markdown file, right? That seems very specific. How do we know that?
In any case, this seems like something that should be explained in a comment.
There was a problem hiding this comment.
Thanks for this comment because my assumption was that wiki documents can only be created in markdown format, but it turns out github supports all of these:
Even though markdown is set by default and most wikis would be using markdown, best solution would be to just remove the file extension, whatever it is. I'll do that
| if commit != "" { | ||
| baseLink += commit | ||
| } | ||
| if line > 0 { | ||
| baseLink += "#L" + strconv.FormatInt(line, 10) | ||
| } |
There was a problem hiding this comment.
If these are real possibilities, I think they should have test cases.
…-not-work-for-GH-Wiki-pages
rosecodym
left a comment
rosecodym
left a comment
There was a problem hiding this comment.
I am taking it on faith that the base link mangling is correct, but you're the expert here!
3 participants
Description:
This PR fixes a bug with link generation for GH wiki pages.
Checklist:
make test-community)?make lintthis requires golangci-lint)?