Add CI job for finding invalid links in markdown files (#1244)

* Added markdown-link-check

* Update changelog

* Added config file

* Added ignore pattern for crates.io, simplified output

* Added ignore pattern for localhost

* Fix ignore patterns in markdown-link-check config

* Better Github relative link for directory

* Fix Github relative links within the project

* Fixed two broken links

* Fixed last broken link

* Reverted changelog

* Removed pending changelog file

Co-authored-by: Adi Seredinschi <[email protected]>

Author: rnbguy

.changelog/epilogue.md

@@ -73,7 +73,7 @@ with the changes described below.
 
 #### Added inline documentation for all options.
 
-Please have a look around the [config.toml](./config.toml) directly.
+Please have a look around the [config.toml](https://github.com/informalsystems/ibc-rs/blob/v0.6.0/config.toml) directly.
 
 #### Added a packet filtering mechanism based on channel/port identifiers
 

.github/markdown-link-check.json

@@ -0,0 +1,11 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^https://crates.io"
+    },
+    {
+      "pattern": "^https?://localhost"
+    }
+  ],
+  "aliveStatusCodes": [429, 200]
+}

.github/workflows/markdown-link-check.yml

@@ -0,0 +1,21 @@
+name: Check Markdown links
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+  workflow_dispatch:
+
+jobs:
+  md-link-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: markdown-link-check
+        uses: gaurav-nelson/[email protected]
+        with:
+          config-file: '.github/markdown-link-check.json'
+          use-quiet-mode: 'yes'
+          use-verbose-mode: 'yes'

README.md

@@ -25,7 +25,7 @@ This project comprises primarily four crates:
 
 See the table below for more details.
 
-Includes [TLA+ specifications](/docs/spec).
+Includes [TLA+ specifications](docs/spec).
 
 | Crate name    |   Type   |     Version       | Docs   |
 |:-------------:|:------:|:-------------:|:-----:|

docs/architecture/adr-006-hermes-v0.2-usecases.md

@@ -290,6 +290,6 @@ Partially implemented.
 [#628]: https://github.com/informalsystems/ibc-rs/issues/628
 [#673]: https://github.com/informalsystems/ibc-rs/issues/673
 [#640]: https://github.com/informalsystems/ibc-rs/issues/640
-[client-state]: https://hermes.informal.systems/query_client.html#query-the-client-state
+[client-state]: https://hermes.informal.systems/commands/queries/client.html#query-the-client-state
 [client-create]: https://docs.rs/ibc/0.1.1/ibc/ics02_client/msgs/create_client/index.html
 [output]: https://github.com/informalsystems/ibc-rs/blob/1f2e72dbcafee5a8bbdab381ff4927d5870b4b59/relayer-cli/src/conclude.rs#L80

docs/spec/tla/fungible-token-transfer/README.md

@@ -26,7 +26,7 @@ modules](#helper-modules).
 
 In the model we assume that the [`setup()`](https://github.com/cosmos/ics/tree/5877197dc03e844542cb8628dd52674a37ca6ff9/spec/ics-020-fungible-token-transfer#port--channel-setup) function has been called
 before. The [channel handshake
-functions]((https://github.com/cosmos/ics/tree/5877197dc03e844542cb8628dd52674a37ca6ff9/spec/ics-020-fungible-token-transfer#channel-lifecycle-management))
+functions](https://github.com/cosmos/ics/tree/5877197dc03e844542cb8628dd52674a37ca6ff9/spec/ics-020-fungible-token-transfer#channel-lifecycle-management)
 are also considered being already executed. Our
 model starts from a state where the channel handshake has completed
 successfully. 
@@ -55,7 +55,7 @@ This module captures the functions
 specifying packet flow and handling from [ICS
 04](https://github.com/cosmos/ics/tree/5877197dc03e844542cb8628dd52674a37ca6ff9/spec/ics-004-channel-and-packet-semantics). 
 
-#### [Bank.tla](bank.tla) 
+#### [Bank.tla](Bank.tla) 
 The bank module encodes functions defined by the Cosmos bank
   application. 
 

guide/src/commands/relaying/index.md

@@ -3,7 +3,7 @@ This section describes the types of relaying that hermes can perform.
 
 Hermes can send transactions triggered by IBC events. It currently handles channel handshake and packet events:
  - [packets messages only](./packets.md#packet-relaying)
- - [channel and packet messages](channel.md#channel-handshake-relaying)
+ - [channel and packet messages](./handshakes.md)
 
 ## The `start` Command
 

guide/src/commands/relaying/packets.md

@@ -46,5 +46,5 @@ In addition to these events, the relayer will also handle channel closing events
 
 If the relay path is using a non-zero delay connection, then `hermes` will delay all packet transactions. The delay is relative to the submission time for the client update at the height required by the packet proof.
 The delay is used to prevent light client attacks and ensures that misbehavior detection finalizes before the transaction is submitted.
-For more information on the misbehavior detector see [the misbehaviour section](../../misbehaviour/index.md#monitoring-misbehaviour-and-evidence-submission).
+For more information on the misbehavior detector see [the misbehaviour section](../misbehaviour/index.md#monitoring-misbehaviour-and-evidence-submission).
 

guide/src/config.md

@@ -261,4 +261,4 @@ on [inspecting the relayer state](help.md#inspecting-the-relayer-state).
 
 Now that you learned how to build the relayer and how to create a configuration file, you can go to the [`Two Chains`](./tutorials/local-chains/index.md) tutorial to learn how to perform some local testing connecting the relayer to two local chains.
 
-[log-level]: ./help.html#parametrizing-the-log-output-level
+[log-level]: ./help.md#parametrizing-the-log-output-level