Improve Github Actions by adding super linter

.github/workflows/markdown-ci/markdown-config.yml → .github/linters/.markdown-lint.yml

@@ -4,11 +4,11 @@ default: false # includes/excludes all rules by default
 MD001: true
 
 # Heading style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md003>
-MD003: true
+MD003:
   style: 'consistent'
 
 # Unordered list style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md004>
-MD004: true
+MD004:
   style: 'consistent'
 
 # Inconsistent indentation for list items at the same level <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md005>
@@ -30,7 +30,7 @@ MD010: false
 MD011: true
 
 # Multiple consecutive blank lines <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md012>
-MD012: true
+MD012:
   maximum: 2
 
 # Line length <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md013>
@@ -58,7 +58,7 @@ MD022: true
 MD023: true
 
 # Multiple headings with the same content <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md024>
-MD024: true
+MD024:
   allow_different_nesting: true
 
 # Multiple top level headings in the same document <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md025>
@@ -74,7 +74,7 @@ MD027: true
 MD028: false
 
 # Ordered list item prefix <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md029>
-MD029: true
+MD029:
   style: 'one_or_ordered'
 
 # Spaces after list markers <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md030>
@@ -87,7 +87,7 @@ MD031: true
 MD032: true
 
 # Inline HTML <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md033>
-MD033: true
+MD033:
   allowed_elements: ['a']
 
 # Bare URL used <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md034>
@@ -137,9 +137,3 @@ MD047: true
 # Code fence style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md048>
 MD048:
   style: 'consistent'
-
-# Custom rules:
-# CHANGELOG-RULE-001: false
-# CHANGELOG-RULE-002: false
-# CHANGELOG-RULE-003: false
-# CHANGELOG-RULE-004: false

.github/workflows/lint.yml

@@ -0,0 +1,60 @@
+name: Lint
+
+on: [push]
+
+jobs:
+
+  # We can't use VALIDATE_GO from super linter because of this issue:
+  # https://github.com/github/super-linter/issues/143
+  go-lint:
+    name: Lint go
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v2
+        with:
+          version: v1.43.0
+          args: --timeout 5m0s
+
+  md-link-check:
+    name: Check markdown links
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Check if Markdown links are valid
+        uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with: 
+          config-file: '.github/linters/mlc_config.json'
+          folder-path: "."
+
+  super-lint:
+    name: Run super linter
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Super-Linter
+      uses: github/super-linter/slim@v4
+      env:
+        VALIDATE_MARKDOWN: true
+        VALIDATE_XML: true
+        VALIDATE_YAML: true
+        VALIDATE_OPENAPI: true
+        # VALIDATE_BASH: true
+        # VALIDATE_BASH_EXEC: true
+        # VALIDATE_DOCKERFILE_HADOLINT: true
+        # VALIDATE_ENV: true
+        # VALIDATE_GITHUB_ACTIONS: true
+        # VALIDATE_PROTOBUF: true
+        # VALIDATE_SHELL_SHFMT: true
+
+        VALIDATE_ALL_CODEBASE: true
+        LOG_LEVEL: WARN
+
+        DEFAULT_BRANCH: main
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/node-ci.yml → .github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: cheqd-node CI
+name: Test
 
 on:
   push:
@@ -14,22 +14,10 @@ env:
   VERSION: "1.0.0" # Package build scripts require version to be provided
 
 jobs:
-  lint:
-    name: Lint
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: golangci-lint
-        uses: golangci/golangci-lint-action@v2
-        with:
-          version: v1.43.0
-          args: --timeout 5m0s
 
   run-unit-test:
     name: Run unit tests
     runs-on: ubuntu-20.04
-    needs: lint
     steps:
       - name: Set up Go 1.17
         uses: actions/setup-go@v2

README.md

@@ -65,9 +65,9 @@ The [**cheqd Community Slack**](http://cheqd.link/join-cheqd-slack) is our chat
 
 Please reach out to us there for discussions, help, and feedback on the project.
 
-## Bug Reporting & New Feature Requests 
+## Bug Reporting & New Feature Requests
 
-If you notice anything not behaving how you expected, or would like to make a suggestion / request for a new feature, please submit a **bug_report** or **feature_request**  by creating a [**New Issue**](https://github.com/cheqd/cheqd-node/issues/new/choose) and selecting the relevant template. 
+If you notice anything not behaving how you expected, or would like to make a suggestion / request for a new feature, please submit a **bug_report** or **feature_request**  by creating a [**New Issue**](https://github.com/cheqd/cheqd-node/issues/new/choose) and selecting the relevant template.
 
 
 ### Social media

architecture/adr-list/adr-001-payment-mechanism-for-issuing-credentials.md

@@ -83,7 +83,7 @@ The payment flow can be broken down into five steps:
    * **`denom`**: Defined in `details.total.amount.currency` from the Payment Request
 2. **Build a transaction with the request from the previous step** Example: `cheqd_ledger::auth::build_tx(pool_alias, pub_key, builded_request, account_number, account_sequence, max_gas, max_coin_amount, denom, timeout_height, memo)`
    * `memo`: This should be the same as `details.id` from the Payment Request
-3. **Sign the transaction** Example:`cheqd_keys::sign(wallet_handle, key_alias, tx)`. 
+3. **Sign the transaction** Example:`cheqd_keys::sign(wallet_handle, key_alias, tx)`.
 4. **Broadcast the signed transaction** Example: `cheqd_pool::broadcast_tx_commit(pool_alias, signed)`.
 
 #### Response format
@@ -197,7 +197,7 @@ Holder -> Issuer: Accept
 
 ## References
 
-* [Hyperledger Aries RFC 0036: Issue Credential Protocol 1.0 ](https://github.com/hyperledger/aries-rfcs/blob/main/features/0036-issue-credential/README.md)
+* [Hyperledger Aries RFC 0036: Issue Credential Protocol 1.0](https://github.com/hyperledger/aries-rfcs/blob/main/features/0036-issue-credential/README.md)
 * [Hyperledger Aries RFC 0075: Payment Decorators](https://github.com/hyperledger/aries-rfcs/blob/main/features/0075-payment-decorators/README.md)
 * [Evernym VDR Tools cheqd network payments ADR](https://gitlab.com/evernym/verity/vdr-tools/-/tree/cheqd/docs/design/014-bank-transactions)
 

architecture/adr-list/adr-003-cli-tools.md

@@ -13,7 +13,7 @@
 
 Due to the nature of the cheqd project merging concepts from the [Cosmos blockchain framework](https://github.com/cosmos/cosmos-sdk) and self-sovereign identity \(SSI\), there are two potential options for creating Command Line Interface \(CLI\) tools for developers to use:
 
-1. **Cosmos-based CLI:** Most likely route for Cosmos projects for their node application. Most existing Cosmos node validators will be familiar with this method of managing their node. 
+1. **Cosmos-based CLI:** Most likely route for Cosmos projects for their node application. Most existing Cosmos node validators will be familiar with this method of managing their node.
 2. **VDR CLI**: Traditionally, a lot of SSI networks have used [Hyperledger Indy](https://github.com/hyperledger/indy-node) and therefore the Indy CLI tool for managing and interacting with the ledger. This has now been renamed to [Verifiable Data Registry \(VDR\) Tools CLI](https://gitlab.com/evernym/verity/vdr-tools) and is the tool that most existing SSI node operators \("stewards"\) would be familiar with.
 
 Ideally, the `cheqd-node` project would provide a consistent set of CLI tools rather than two separate tools with varying feature sets between them.
@@ -41,7 +41,7 @@ This ADR will focus on the CLI tool architecture choice for `cheqd-node`.
 
 ### Options considered
 
-#### 1. Keep both Cosmos CLI and VDR Tools CLI, but use them for different purposes.
+#### 1. Keep both Cosmos CLI and VDR Tools CLI, but use them for different purposes
 
 **Pros:**
 

architecture/adr-list/adr-005-genesis-parameters.md

@@ -125,16 +125,16 @@ Cosmos application is divided [into a list of modules](https://docs.cosmos.netwo
     * Amount of unbound/redelegate entries to store
   * `bond_denom` = `ncheq`
     * Denomination used in staking
-*  **`ibc`**
-     * `max_expected_time_per_block` = `30000000000` (expressed in nanoseconds, ~ 30 seconds)
-       * Maximum expected time per block, used to enforce block delay. This parameter should reflect the largest amount of time that the chain might reasonably take to produce the next block under normal operating conditions. A safe choice is 3-5x the expected time per block.
-     * `allowed_clients` = `[ "06-solomachine", "07-tendermint" ]`
-       * Defines the list of allowed client state types. We allow connections from other chains using the [Tendermint client](https://github.com/cosmos/ibc-go/blob/main/modules/light-clients/07-tendermint), and with light clients using the [Solo Machine client](https://github.com/cosmos/ibc-go/blob/main/modules/light-clients/06-solomachine).
-   * **`ibc-transfer`**
-     * `send_enabled` = `true`
-       * Enables or disables all cross-chain token transfers from this chain
-     * `receive_enabled` = `true`
-       * Enables or disables all cross-chain token transfers to this chain
+* **`ibc`**
+  * `max_expected_time_per_block` = `30000000000` (expressed in nanoseconds, ~ 30 seconds)
+    * Maximum expected time per block, used to enforce block delay. This parameter should reflect the largest amount of time that the chain might reasonably take to produce the next block under normal operating conditions. A safe choice is 3-5x the expected time per block.
+  * `allowed_clients` = `[ "06-solomachine", "07-tendermint" ]`
+    * Defines the list of allowed client state types. We allow connections from other chains using the [Tendermint client](https://github.com/cosmos/ibc-go/blob/main/modules/light-clients/07-tendermint), and with light clients using the [Solo Machine client](https://github.com/cosmos/ibc-go/blob/main/modules/light-clients/06-solomachine).
+* **`ibc-transfer`**
+  * `send_enabled` = `true`
+    * Enables or disables all cross-chain token transfers from this chain
+  * `receive_enabled` = `true`
+    * Enables or disables all cross-chain token transfers to this chain
 
 ## Decision