Add markdown linter (#675)

* Markdown linter

* Fix MD files

* Fix formatting

Author: anakinj

.github/workflows/push_gem.yml

@@ -1,16 +1,16 @@
 ---
-  'on':
-    push:
-      tags:
+"on":
+  push:
+    tags:
       - v*
-  name: Push Gem
-  jobs:
-    push:
-      runs-on: ubuntu-latest
-      permissions:
-        contents: write
-        id-token: write
-      steps:
+name: Push Gem
+jobs:
+  push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
       - uses: rubygems/configure-rubygems-credentials@main
         with:
           role-to-assume: ${{ secrets.RUBYGEMS_PUSH_ROLE }}
@@ -36,4 +36,4 @@
               raise "No spec for #{ARGV[0]}" unless spec
               print [spec.name, spec.version, spec.platform].join(":")
             ' "jwt")"
-          gem await "${gem_tuple}"
+          gem await "${gem_tuple}"

.github/workflows/test.yml

@@ -8,7 +8,7 @@ on:
     branches:
       - "*"
 jobs:
-  lint:
+  rubocop:
     name: RuboCop
     timeout-minutes: 30
     runs-on: ubuntu-latest
@@ -21,6 +21,13 @@ jobs:
           bundler-cache: true
       - name: Run RuboCop
         run: bundle exec rubocop
+  markdown:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Lint Markdown
+        uses: actionshub/[email protected]
   test:
     name: ${{ matrix.os }} - Ruby ${{ matrix.ruby }} - ${{ matrix.gemfile }}
     runs-on: ${{ matrix.os }}
@@ -44,15 +51,15 @@ jobs:
         include:
           - os: ubuntu-latest
             ruby: "3.0"
-            gemfile: 'gemfiles/openssl.gemfile'
+            gemfile: "gemfiles/openssl.gemfile"
             experimental: false
           - os: ubuntu-latest
             ruby: "truffleruby-head"
-            gemfile: 'gemfiles/standalone.gemfile'
+            gemfile: "gemfiles/standalone.gemfile"
             experimental: true
           - os: ubuntu-latest
             ruby: "head"
-            gemfile: 'gemfiles/standalone.gemfile'
+            gemfile: "gemfiles/standalone.gemfile"
             experimental: true
     continue-on-error: ${{ matrix.experimental }}
     env:

.mdlrc

@@ -0,0 +1 @@
+rules "~MD013"

CHANGELOG.md

@@ -5,6 +5,7 @@
 [Full Changelog](https://github.com/jwt/ruby-jwt/compare/v2.10.1...main)
 
 **Breaking changes:**
+
 - Require token signature to be verified before accessing payload [#648](https://github.com/jwt/ruby-jwt/pull/648) ([@anakinj](https://github.com/anakinj))
 - Drop support for the HS512256 algorithm [#650](https://github.com/jwt/ruby-jwt/pull/650) ([@anakinj](https://github.com/anakinj))
 - Remove deprecated claim verification methods [#654](https://github.com/jwt/ruby-jwt/pull/654) ([@anakinj](https://github.com/anakinj))
@@ -17,6 +18,7 @@
 Take a look at the [upgrade guide](UPGRADING.md) for more details.
 
 **Features:**
+
 - JWT::EncodedToken#verify! method that bundles signature and claim validation [#647](https://github.com/jwt/ruby-jwt/pull/647) ([@anakinj](https://github.com/anakinj))
 - Do not override the alg header if already given [#659](https://github.com/jwt/ruby-jwt/pull/659) ([@anakinj](https://github.com/anakinj))
 - Make `JWK::KeyFinder` compatible with `JWT::EncodedToken` [#663](https://github.com/jwt/ruby-jwt/pull/663) ([@anakinj](https://github.com/anakinj))
@@ -190,6 +192,7 @@ Take a look at the [upgrade guide](UPGRADING.md) for more details.
 - Support OpenSSL >= 3.0 [#496](https://github.com/jwt/ruby-jwt/pull/496) ([@anakinj](https://github.com/anakinj))
 
 **Fixes and enhancements:**
+
 - Bring back the old Base64 (RFC2045) deocode mechanisms [#488](https://github.com/jwt/ruby-jwt/pull/488) ([@anakinj](https://github.com/anakinj))
 - Rescue RbNaCl exception for EdDSA wrong key [#491](https://github.com/jwt/ruby-jwt/pull/491) ([@n-studio](https://github.com/n-studio))
 - New parameter name for cases when kid is not found using JWK key loader proc [#501](https://github.com/jwt/ruby-jwt/pull/501) ([@anakinj](https://github.com/anakinj))
@@ -200,6 +203,7 @@ Take a look at the [upgrade guide](UPGRADING.md) for more details.
 [Full Changelog](https://github.com/jwt/ruby-jwt/compare/v2.4.0...v2.4.1)
 
 **Fixes and enhancements:**
+
 - Raise JWT::DecodeError on invalid signature [\#484](https://github.com/jwt/ruby-jwt/pull/484) ([@freakyfelt!](https://github.com/freakyfelt!))
 
 ## [v2.4.0](https://github.com/jwt/ruby-jwt/tree/v2.4.0) (2022-06-06)
@@ -217,6 +221,7 @@ Take a look at the [upgrade guide](UPGRADING.md) for more details.
 - Add Support to be able to verify from multiple keys [\#425](https://github.com/jwt/ruby-jwt/pull/425) ([ritikesh](https://github.com/ritikesh))
 
 **Fixes and enhancements:**
+
 - Readme: Typo fix re MissingRequiredClaim [\#451](https://github.com/jwt/ruby-jwt/pull/451) ([antonmorant](https://github.com/antonmorant))
 - Fix RuboCop TODOs [\#476](https://github.com/jwt/ruby-jwt/pull/476) ([typhoon2099](https://github.com/typhoon2099))
 - Make specific algorithms in README linkable [\#472](https://github.com/jwt/ruby-jwt/pull/472) ([milieu](https://github.com/milieu))
@@ -638,7 +643,7 @@ Take a look at the [upgrade guide](UPGRADING.md) for more details.
 
 **Closed issues:**
 
-- 404 at https://rubygems.global.ssl.fastly.net/gems/jwt-1.5.3.gem [\#137](https://github.com/jwt/ruby-jwt/issues/137)
+- 404 at [https://rubygems.global.ssl.fastly.net/gems/jwt-1.5.3.gem](https://rubygems.global.ssl.fastly.net/gems/jwt-1.5.3.gem) [\#137](https://github.com/jwt/ruby-jwt/issues/137)
 
 **Merged pull requests:**
 
@@ -957,7 +962,3 @@ Take a look at the [upgrade guide](UPGRADING.md) for more details.
 
 - Bumped a version and added a .gemspec using rake build\_gemspec [\#3](https://github.com/jwt/ruby-jwt/pull/3) ([zhitomirskiyi](https://github.com/zhitomirskiyi))
 - Added RSA support [\#2](https://github.com/jwt/ruby-jwt/pull/2) ([zhitomirskiyi](https://github.com/zhitomirskiyi))
-
-
-
-\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

CODE_OF_CONDUCT.md

@@ -74,11 +74,11 @@ Community leaders will follow these Community Impact Guidelines in determining t
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
 
 Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
 
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

CONTRIBUTING.md

@@ -44,6 +44,7 @@ Implement tests and your change. Don't be shy adding a little something in the [
 Add a short description of the change in either the `Features` or `Fixes` section in the [CHANGELOG](CHANGELOG.md) file.
 
 The form of the row (You need to return to the row when you know the pull request id)
+
 ```
 - Fix a little problem [#123](https://github.com/jwt/ruby-jwt/pull/123) - [@you](https://github.com/you).
 ```
@@ -87,7 +88,7 @@ git rebase upstream/main
 git push origin fix-a-little-problem -f
 ```
 
-# Releasing a new version
+## Releasing a new version
 
 The version is using the [Semantic Versioning](http://semver.org/) and the version is located in the [version.rb](lib/jwt/version.rb) file.
 Also update the [CHANGELOG](CHANGELOG.md) to reflect the upcoming version release.