fix: check other possible readme paths/branches (#450)

* fix: check other possible readme paths/branches

Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>

* fix: url

Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>

* fix: Readme.md

---------

Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
This commit is contained in:
Carlos Alexandro Becker 2024-07-03 13:09:20 -03:00 committed by GitHub
parent f3d0cb89da
commit 8e51396575
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 46 additions and 38 deletions

View file

@ -2,6 +2,7 @@ package main
import (
"errors"
"fmt"
"net/http"
"net/url"
"strings"
@ -29,9 +30,10 @@ func findGitHubREADME(s string) (*source, error) {
}
u.Host = "raw.githubusercontent.com"
for _, b := range readmeBranches {
for _, r := range readmeNames {
v := u
v.Path += "/master/" + r
v := *u
v.Path += fmt.Sprintf("/%s/%s", b, r)
// nolint:bodyclose
// it is closed on the caller
@ -44,6 +46,7 @@ func findGitHubREADME(s string) (*source, error) {
return &source{resp.Body, v.String()}, nil
}
}
}
return nil, errors.New("can't find README in GitHub repository")
}

View file

@ -2,6 +2,7 @@ package main
import (
"errors"
"fmt"
"net/http"
"net/url"
"strings"
@ -28,9 +29,10 @@ func findGitLabREADME(s string) (*source, error) {
return nil, err
}
for _, b := range readmeBranches {
for _, r := range readmeNames {
v := u
v.Path += "/raw/master/" + r
v := *u
v.Path += fmt.Sprintf("/raw/%s/%s", b, r)
// nolint:bodyclose
// it is closed on the caller
@ -43,6 +45,7 @@ func findGitLabREADME(s string) (*source, error) {
return &source{resp.Body, v.String()}, nil
}
}
}
return nil, errors.New("can't find README in GitLab repository")
}

View file

@ -14,15 +14,16 @@ func TestGlowSources(t *testing.T) {
}
for _, v := range tt {
t.Run(v, func(t *testing.T) {
buf := &bytes.Buffer{}
err := executeArg(rootCmd, v, buf)
if err != nil {
t.Errorf("Error during execution (args: %s): %v", v, err)
}
if buf.Len() == 0 {
t.Errorf("Output buffer should not be empty (args: %s)", v)
}
})
}
}

View file

@ -28,7 +28,8 @@ var (
// CommitSHA as provided by goreleaser.
CommitSHA = ""
readmeNames = []string{"README.md", "README"}
readmeNames = []string{"README.md", "README", "Readme.md", "Readme", "readme.md", "readme"}
readmeBranches = []string{"main", "master"}
configFile string
pager bool
style string