diff --git a/.github/workflows/link-check.yml b/.github/workflows/link-check.yml new file mode 100644 index 0000000000..87c895d44c --- /dev/null +++ b/.github/workflows/link-check.yml @@ -0,0 +1,17 @@ +name: Markdown Link Checking +on: + pull_request: + push: + branches: + - "master" + +jobs: + check-links: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: gaurav-nelson/github-action-markdown-link-check@v1 + with: + use-quiet-mode: 'yes' # show only broken links + use-verbose-mode: 'yes' + config-file: .github/workflows/markdown-links-config.json # for removing any false positives diff --git a/.github/workflows/markdown-links-config.json b/.github/workflows/markdown-links-config.json new file mode 100644 index 0000000000..505831a198 --- /dev/null +++ b/.github/workflows/markdown-links-config.json @@ -0,0 +1,22 @@ +{ + "ignorePatterns": [ + { + "pattern": "^http://localhost" + }, + { + "pattern": "^https://twitter.com/" + }, + { + "pattern": "^https://opensource.org/" + } + ], + "aliveStatusCodes": [200], + "httpHeaders": [ + { + "urls": ["https://docs.github.com/"], + "headers": { + "Accept-Encoding": "*" + } + } + ] +} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 2306f0ff89..b6ab14c177 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -195,8 +195,8 @@ Fix some test-utils used by https://github.com/libp2p/go-libp2p-kad-dht ### Metrics We've started instrumenting the entire stack. In this release, we're adding metrics for: -* the swarm: tracking incoming and outgoing connections, transports, security protocols and stream multiplexers in use: (https://github.com/libp2p/go-libp2p/blob/master/p2p/net/swarm/grafana-dashboards/swarm.json) -* the event bus: tracking how different events are propagated through the stack and to external consumers (https://github.com/libp2p/go-libp2p/blob/master/p2p/host/eventbus/grafana-dashboards/eventbus.json) +* the swarm: tracking incoming and outgoing connections, transports, security protocols and stream multiplexers in use: (https://github.com/libp2p/go-libp2p/blob/master/dashboards/swarm/swarm.json) +* the event bus: tracking how different events are propagated through the stack and to external consumers (https://github.com/libp2p/go-libp2p/blob/master/dashboards/eventbus/eventbus.json) Our metrics effort is still ongoing, see https://github.com/libp2p/go-libp2p/issues/1356 for progress. We'll add metrics and dashboards for more libp2p components in a future release. diff --git a/examples/multipro/README.md b/examples/multipro/README.md index db032848fb..6fb0b2e967 100644 --- a/examples/multipro/README.md +++ b/examples/multipro/README.md @@ -1,7 +1,7 @@ # Protocol Multiplexing using rpc-style protobufs with libp2p This example shows how to use protobufs to encode and transmit information between libp2p hosts using libp2p Streams. -This example expects that you are already familiar with the [echo example](https://github.com/libp2p/go-libp2p-examples/tree/master/echo). +This example expects that you are already familiar with the [echo example](https://github.com/libp2p/go-libp2p/tree/master/examples/echo). ## Build diff --git a/test-plans/README.md b/test-plans/README.md index 1cc19ab86e..1d180aacd2 100644 --- a/test-plans/README.md +++ b/test-plans/README.md @@ -24,7 +24,7 @@ of these nodes with the other version's interop test. # Running all interop tests locally with Compose To run this test against all released libp2p versions you'll need to have the -(libp2p/test-plans)[https://github.com/libp2p/test-plans] checked out. Then do +[libp2p/test-plans](https://github.com/libp2p/test-plans) checked out. Then do the following (from the root directory of this repository): 1. Build the image: `docker build -t go-libp2p-head -f test-plans/PingDockerfile .`.