From 7c8ba63cf5c88845fce0c140ee807d9dfa965525 Mon Sep 17 00:00:00 2001 From: Aaron Schlesinger Date: Tue, 6 Apr 2021 11:20:13 -0700 Subject: [PATCH 1/5] Adding GH action to check links in documentation --- .github/workflows/linkinator.yml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/workflows/linkinator.yml diff --git a/.github/workflows/linkinator.yml b/.github/workflows/linkinator.yml new file mode 100644 index 000000000..a532cbc0f --- /dev/null +++ b/.github/workflows/linkinator.yml @@ -0,0 +1,17 @@ +name: Check links on all markdown documents +on: + push: + branches: [main] + pull_request: + branches: [main] + +jobs: + linkinator: + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@v2 + - uses: JustinBeckwith/linkinator-action@v1 + with: + paths: "**/*.md" + markdown: true + retry: true From 83fa1deff850e1bbaf7ac5210c8d592a5088137d Mon Sep 17 00:00:00 2001 From: Aaron Schlesinger Date: Tue, 6 Apr 2021 11:32:43 -0700 Subject: [PATCH 2/5] skipping checks on all localhost links and links that don't start with http --- .github/workflows/linkinator.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/linkinator.yml b/.github/workflows/linkinator.yml index a532cbc0f..1526adf12 100644 --- a/.github/workflows/linkinator.yml +++ b/.github/workflows/linkinator.yml @@ -15,3 +15,4 @@ jobs: paths: "**/*.md" markdown: true retry: true + linksToSkip: "http://localhost:1313/, ^(?!http).*" From 140b55745e6a715ac1d51a192b442e990a8b93cb Mon Sep 17 00:00:00 2001 From: Aaron Schlesinger Date: Tue, 6 Apr 2021 11:36:41 -0700 Subject: [PATCH 3/5] more precision in the URL capture --- .github/workflows/linkinator.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/linkinator.yml b/.github/workflows/linkinator.yml index 1526adf12..22340c36d 100644 --- a/.github/workflows/linkinator.yml +++ b/.github/workflows/linkinator.yml @@ -15,4 +15,4 @@ jobs: paths: "**/*.md" markdown: true retry: true - linksToSkip: "http://localhost:1313/, ^(?!http).*" + linksToSkip: "http://localhost:1313/, ^((?!http).)*$" From b1e509976ffe45e82d4ee166c64a596b7c27cc61 Mon Sep 17 00:00:00 2001 From: Aaron Schlesinger Date: Tue, 6 Apr 2021 11:41:03 -0700 Subject: [PATCH 4/5] Changing godoc.org links to pkg.go.dev The linkinator wants HTTP 200 responses. godoc.org returns 302s to redirect to pkg.go.dev --- README.md | 2 +- SHOULDERS.md | 100 +++++++++++++------------- config.dev.toml | 8 +-- docs/content/configuration/storage.md | 8 +-- 4 files changed, 59 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 5071b31d1..def7967d0 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ![Athens Banner](./docs/static/banner.png) [![Build Status](https://cloud.drone.io/api/badges/gomods/athens/status.svg)](https://cloud.drone.io/gomods/athens) -[![GoDoc](https://godoc.org/github.com/gomods/athens?status.svg)](https://godoc.org/github.com/gomods/athens) +[![GoDoc](https://pkg.go.dev/github.com/gomods/athens?status.svg)](https://pkg.go.dev/github.com/gomods/athens) [![Go Report Card](https://goreportcard.com/badge/github.com/gomods/athens)](https://goreportcard.com/report/github.com/gomods/athens) [![codecov](https://codecov.io/gh/gomods/athens/branch/master/graph/badge.svg)](https://codecov.io/gh/gomods/athens) [![Docker Pulls](https://img.shields.io/docker/pulls/gomods/athens.svg?maxAge=604800)](https://hub.docker.com/r/gomods/athens/) diff --git a/SHOULDERS.md b/SHOULDERS.md index 45aea5d2a..6e9317fa0 100644 --- a/SHOULDERS.md +++ b/SHOULDERS.md @@ -5,102 +5,102 @@ Athens does not try to reinvent the wheel! Instead, it uses the already great wh Thank you to the following **GIANTS**: -* [cloud.google.com/go](https://godoc.org/cloud.google.com/go) +* [cloud.google.com/go](https://pkg.go.dev/cloud.google.com/go) -* [contrib.go.opencensus.io/exporter/stackdriver](https://godoc.org/contrib.go.opencensus.io/exporter/stackdriver) +* [contrib.go.opencensus.io/exporter/stackdriver](https://pkg.go.dev/contrib.go.opencensus.io/exporter/stackdriver) -* [github.com/Azure/azure-storage-blob-go](https://godoc.org/github.com/Azure/azure-storage-blob-go) +* [github.com/Azure/azure-storage-blob-go](https://pkg.go.dev/github.com/Azure/azure-storage-blob-go) -* [github.com/BurntSushi/toml](https://godoc.org/github.com/BurntSushi/toml) +* [github.com/BurntSushi/toml](https://pkg.go.dev/github.com/BurntSushi/toml) -* [github.com/DataDog/datadog-go](https://godoc.org/github.com/DataDog/datadog-go) +* [github.com/DataDog/datadog-go](https://pkg.go.dev/github.com/DataDog/datadog-go) -* [github.com/DataDog/opencensus-go-exporter-datadog](https://godoc.org/github.com/DataDog/opencensus-go-exporter-datadog) +* [github.com/DataDog/opencensus-go-exporter-datadog](https://pkg.go.dev/github.com/DataDog/opencensus-go-exporter-datadog) -* [github.com/aws/aws-sdk-go](https://godoc.org/github.com/aws/aws-sdk-go) +* [github.com/aws/aws-sdk-go](https://pkg.go.dev/github.com/aws/aws-sdk-go) -* [github.com/fatih/color](https://godoc.org/github.com/fatih/color) +* [github.com/fatih/color](https://pkg.go.dev/github.com/fatih/color) -* [github.com/globalsign/mgo](https://godoc.org/github.com/globalsign/mgo) +* [github.com/globalsign/mgo](https://pkg.go.dev/github.com/globalsign/mgo) -* [github.com/go-playground/locales](https://godoc.org/github.com/go-playground/locales) +* [github.com/go-playground/locales](https://pkg.go.dev/github.com/go-playground/locales) -* [github.com/go-playground/universal-translator](https://godoc.org/github.com/go-playground/universal-translator) +* [github.com/go-playground/universal-translator](https://pkg.go.dev/github.com/go-playground/universal-translator) -* [github.com/gobuffalo/envy](https://godoc.org/github.com/gobuffalo/envy) +* [github.com/gobuffalo/envy](https://pkg.go.dev/github.com/gobuffalo/envy) -* [github.com/gobuffalo/httptest](https://godoc.org/github.com/gobuffalo/httptest) +* [github.com/gobuffalo/httptest](https://pkg.go.dev/github.com/gobuffalo/httptest) -* [github.com/gogo/protobuf](https://godoc.org/github.com/gogo/protobuf) +* [github.com/gogo/protobuf](https://pkg.go.dev/github.com/gogo/protobuf) -* [github.com/golang/glog](https://godoc.org/github.com/golang/glog) +* [github.com/golang/glog](https://pkg.go.dev/github.com/golang/glog) -* [github.com/google/go-cmp](https://godoc.org/github.com/google/go-cmp) +* [github.com/google/go-cmp](https://pkg.go.dev/github.com/google/go-cmp) -* [github.com/google/martian](https://godoc.org/github.com/google/martian) +* [github.com/google/martian](https://pkg.go.dev/github.com/google/martian) -* [github.com/googleapis/gax-go](https://godoc.org/github.com/googleapis/gax-go) +* [github.com/googleapis/gax-go](https://pkg.go.dev/github.com/googleapis/gax-go) -* [github.com/gopherjs/gopherjs](https://godoc.org/github.com/gopherjs/gopherjs) +* [github.com/gopherjs/gopherjs](https://pkg.go.dev/github.com/gopherjs/gopherjs) -* [github.com/gorilla/mux](https://godoc.org/github.com/gorilla/mux) +* [github.com/gorilla/mux](https://pkg.go.dev/github.com/gorilla/mux) -* [github.com/hashicorp/go-multierror](https://godoc.org/github.com/hashicorp/go-multierror) +* [github.com/hashicorp/go-multierror](https://pkg.go.dev/github.com/hashicorp/go-multierror) -* [github.com/jtolds/gls](https://godoc.org/github.com/jtolds/gls) +* [github.com/jtolds/gls](https://pkg.go.dev/github.com/jtolds/gls) -* [github.com/kelseyhightower/envconfig](https://godoc.org/github.com/kelseyhightower/envconfig) +* [github.com/kelseyhightower/envconfig](https://pkg.go.dev/github.com/kelseyhightower/envconfig) -* [github.com/konsorten/go-windows-terminal-sequences](https://godoc.org/github.com/konsorten/go-windows-terminal-sequences) +* [github.com/konsorten/go-windows-terminal-sequences](https://pkg.go.dev/github.com/konsorten/go-windows-terminal-sequences) -* [github.com/kr/pretty](https://godoc.org/github.com/kr/pretty) +* [github.com/kr/pretty](https://pkg.go.dev/github.com/kr/pretty) -* [github.com/mattn/go-colorable](https://godoc.org/github.com/mattn/go-colorable) +* [github.com/mattn/go-colorable](https://pkg.go.dev/github.com/mattn/go-colorable) -* [github.com/mattn/go-isatty](https://godoc.org/github.com/mattn/go-isatty) +* [github.com/mattn/go-isatty](https://pkg.go.dev/github.com/mattn/go-isatty) -* [github.com/minio/minio-go](https://godoc.org/github.com/minio/minio-go) +* [github.com/minio/minio-go](https://pkg.go.dev/github.com/minio/minio-go) -* [github.com/mitchellh/go-homedir](https://godoc.org/github.com/mitchellh/go-homedir) +* [github.com/mitchellh/go-homedir](https://pkg.go.dev/github.com/mitchellh/go-homedir) -* [github.com/philhofer/fwd](https://godoc.org/github.com/philhofer/fwd) +* [github.com/philhofer/fwd](https://pkg.go.dev/github.com/philhofer/fwd) -* [github.com/prometheus/client_golang](https://godoc.org/github.com/prometheus/client_golang) +* [github.com/prometheus/client_golang](https://pkg.go.dev/github.com/prometheus/client_golang) -* [github.com/sirupsen/logrus](https://godoc.org/github.com/sirupsen/logrus) +* [github.com/sirupsen/logrus](https://pkg.go.dev/github.com/sirupsen/logrus) -* [github.com/smartystreets/assertions](https://godoc.org/github.com/smartystreets/assertions) +* [github.com/smartystreets/assertions](https://pkg.go.dev/github.com/smartystreets/assertions) -* [github.com/smartystreets/goconvey](https://godoc.org/github.com/smartystreets/goconvey) +* [github.com/smartystreets/goconvey](https://pkg.go.dev/github.com/smartystreets/goconvey) -* [github.com/spf13/afero](https://godoc.org/github.com/spf13/afero) +* [github.com/spf13/afero](https://pkg.go.dev/github.com/spf13/afero) -* [github.com/stretchr/testify](https://godoc.org/github.com/stretchr/testify) +* [github.com/stretchr/testify](https://pkg.go.dev/github.com/stretchr/testify) -* [github.com/tinylib/msgp](https://godoc.org/github.com/tinylib/msgp) +* [github.com/tinylib/msgp](https://pkg.go.dev/github.com/tinylib/msgp) -* [github.com/unrolled/secure](https://godoc.org/github.com/unrolled/secure) +* [github.com/unrolled/secure](https://pkg.go.dev/github.com/unrolled/secure) -* [go.opencensus.io](https://godoc.org/go.opencensus.io) +* [go.opencensus.io](https://pkg.go.dev/go.opencensus.io) -* [golang.org/x/crypto](https://godoc.org/golang.org/x/crypto) +* [golang.org/x/crypto](https://pkg.go.dev/golang.org/x/crypto) -* [golang.org/x/net](https://godoc.org/golang.org/x/net) +* [golang.org/x/net](https://pkg.go.dev/golang.org/x/net) -* [golang.org/x/oauth2](https://godoc.org/golang.org/x/oauth2) +* [golang.org/x/oauth2](https://pkg.go.dev/golang.org/x/oauth2) -* [golang.org/x/sync](https://godoc.org/golang.org/x/sync) +* [golang.org/x/sync](https://pkg.go.dev/golang.org/x/sync) -* [golang.org/x/sys](https://godoc.org/golang.org/x/sys) +* [golang.org/x/sys](https://pkg.go.dev/golang.org/x/sys) -* [google.golang.org/api](https://godoc.org/google.golang.org/api) +* [google.golang.org/api](https://pkg.go.dev/google.golang.org/api) -* [google.golang.org/appengine](https://godoc.org/google.golang.org/appengine) +* [google.golang.org/appengine](https://pkg.go.dev/google.golang.org/appengine) -* [gopkg.in/DataDog/dd-trace-go.v1](https://godoc.org/gopkg.in/DataDog/dd-trace-go.v1) +* [gopkg.in/DataDog/dd-trace-go.v1](https://pkg.go.dev/gopkg.in/DataDog/dd-trace-go.v1) -* [gopkg.in/check.v1](https://godoc.org/gopkg.in/check.v1) +* [gopkg.in/check.v1](https://pkg.go.dev/gopkg.in/check.v1) -* [gopkg.in/go-playground/assert.v1](https://godoc.org/gopkg.in/go-playground/assert.v1) +* [gopkg.in/go-playground/assert.v1](https://pkg.go.dev/gopkg.in/go-playground/assert.v1) -* [gopkg.in/go-playground/validator.v9](https://godoc.org/gopkg.in/go-playground/validator.v9) +* [gopkg.in/go-playground/validator.v9](https://pkg.go.dev/gopkg.in/go-playground/validator.v9) diff --git a/config.dev.toml b/config.dev.toml index 426f0b884..b7a520993 100755 --- a/config.dev.toml +++ b/config.dev.toml @@ -414,9 +414,9 @@ IndexType = "none" # attempt to find credentials in the environment, in the shared # configuration (~/.aws/credentials) and from ec2 instance role # credentials. See - # https://godoc.org/github.com/aws/aws-sdk-go#hdr-Configuring_Credentials + # https://pkg.go.dev/github.com/aws/aws-sdk-go#hdr-Configuring_Credentials # and - # https://godoc.org/github.com/aws/aws-sdk-go/aws/session#hdr-Environment_Variables + # https://pkg.go.dev/github.com/aws/aws-sdk-go/aws/session#hdr-Environment_Variables # for environment variables that will affect the aws configuration. # Setting UseDefaultConfiguration would only use default configuration. It will be deprecated in future releases # and is recommended not to use it. @@ -449,9 +449,9 @@ IndexType = "none" # attempt to find credentials in the environment, in the shared # configuration (~/.aws/credentials) and from ec2 instance role # credentials. See - # https://godoc.org/github.com/aws/aws-sdk-go#hdr-Configuring_Credentials + # https://pkg.go.dev/github.com/aws/aws-sdk-go#hdr-Configuring_Credentials # and - # https://godoc.org/github.com/aws/aws-sdk-go/aws/session#hdr-Environment_Variables + # https://pkg.go.dev/github.com/aws/aws-sdk-go/aws/session#hdr-Environment_Variables # for environment variables that will affect the aws configuration. UseDefaultConfiguration = false diff --git a/docs/content/configuration/storage.md b/docs/content/configuration/storage.md index 227166006..c03c68eeb 100644 --- a/docs/content/configuration/storage.md +++ b/docs/content/configuration/storage.md @@ -147,9 +147,9 @@ After this you can pass your credentials inside `config.toml` file. If the acce # attempt to find credentials in the environment, in the shared # configuration (~/.aws/credentials) and from ec2 instance role # credentials. See - # https://godoc.org/github.com/aws/aws-sdk-go#hdr-Configuring_Credentials + # https://pkg.go.dev/github.com/aws/aws-sdk-go#hdr-Configuring_Credentials # and - # https://godoc.org/github.com/aws/aws-sdk-go/aws/session#hdr-Environment_Variables + # https://pkg.go.dev/github.com/aws/aws-sdk-go/aws/session#hdr-Environment_Variables # for environment variables that will affect the aws configuration. # Setting UseDefaultConfiguration would only use default configuration. It will be deprecated in future releases # and is recommended not to use it. @@ -183,9 +183,9 @@ After this you can pass your credentials inside `config.toml` file. If the acce # attempt to find credentials in the environment, in the shared # configuration (~/.aws/credentials) and from ec2 instance role # credentials. See - # https://godoc.org/github.com/aws/aws-sdk-go#hdr-Configuring_Credentials + # https://pkg.go.dev/github.com/aws/aws-sdk-go#hdr-Configuring_Credentials # and - # https://godoc.org/github.com/aws/aws-sdk-go/aws/session#hdr-Environment_Variables + # https://pkg.go.dev/github.com/aws/aws-sdk-go/aws/session#hdr-Environment_Variables # for environment variables that will affect the aws configuration. # Env override: AWS_USE_DEFAULT_CONFIGURATION UseDefaultConfiguration = false From 2342333a4d8bca6ffee3628be84faf2736784238 Mon Sep 17 00:00:00 2001 From: Aaron Schlesinger Date: Tue, 6 Apr 2021 11:49:35 -0700 Subject: [PATCH 5/5] upping verbosity Signed-off-by: Aaron Schlesinger --- .github/workflows/linkinator.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/linkinator.yml b/.github/workflows/linkinator.yml index 22340c36d..71d8ce02a 100644 --- a/.github/workflows/linkinator.yml +++ b/.github/workflows/linkinator.yml @@ -16,3 +16,4 @@ jobs: markdown: true retry: true linksToSkip: "http://localhost:1313/, ^((?!http).)*$" + verbosity: INFO