ci: lint markdown files (open-telemetry#1147)

* ci: add markdown linting Signed-off-by: Naseem <naseem@transit.app> * fix: lint markdown files Signed-off-by: Naseem <naseem@transit.app> * docs: add markdown lint configuration Signed-off-by: Naseem <naseem@transit.app> * docs: lint change log Signed-off-by: Naseem <naseem@transit.app>
t2t2 · Jun 8, 2020 · e93a866 · e93a866
1 parent a4da9de
commit e93a866
Show file tree

Hide file tree

Showing 45 changed files with 559 additions and 364 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -7,31 +7,46 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-
-    - name: restore lerna
-      uses: actions/cache@master # must use unreleased master to cache multiple paths
-      id: cache
-      with:
-        path: |
-          node_modules
-          packages/*/node_modules
-          metapackages/*/node_modules
-        key: ${{ runner.os }}-${{ hashFiles('**/package.json') }}
-
-    - name: Bootstrap
-      if: steps.cache.outputs.cache-hit != 'true'
-      run: |
-        npm install --only=dev --ignore-scripts
-        npx lerna bootstrap --no-ci --ignore-scripts -- --only=dev
-
-    - name: Lint
-      run: |
-        npm run lint
-        npm run lint:examples
-
-    - name: Install and Build API Dependencies
-      run: npx lerna bootstrap --no-ci --scope @opentelemetry/api --include-filtered-dependencies
-
-    - name: Test Docs
-      run: npm run docs-test
+      - uses: actions/checkout@v2
+
+      - name: Lint changelog file
+        uses: avto-dev/markdown-lint@v1
+        with:
+          # Commenting due to
+          # https://github.com/avto-dev/markdown-lint/blob/aab9be9823fcd706f6da3e6ad6c64874c23fbd4c/lint/rules/changelog.js#L51-L71
+          # TODO: adhere to, or overwrite above rule and uncomment rules
+          # rules: "/lint/rules/changelog.js"
+          config: "/lint/config/changelog.yml"
+          args: "./CHANGELOG.md"
+
+      - name: Lint markdown files
+        uses: avto-dev/markdown-lint@v1
+        with:
+          args: "./**/*.md -i ./CHANGELOG.md"
+
+      - name: restore lerna
+        uses: actions/cache@master # must use unreleased master to cache multiple paths
+        id: cache
+        with:
+          path: |
+            node_modules
+            packages/*/node_modules
+            metapackages/*/node_modules
+          key: ${{ runner.os }}-${{ hashFiles('**/package.json') }}
+
+      - name: Bootstrap
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: |
+          npm install --only=dev --ignore-scripts
+          npx lerna bootstrap --no-ci --ignore-scripts -- --only=dev
+
+      - name: Lint
+        run: |
+          npm run lint
+          npm run lint:examples
+
+      - name: Install and Build API Dependencies
+        run: npx lerna bootstrap --no-ci --scope @opentelemetry/api --include-filtered-dependencies
+
+      - name: Test Docs
+        run: npm run docs-test
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -0,0 +1,6 @@
+{
+  "MD013": false,
+  "MD024": false,
+  "MD033": false,
+  "MD041": false
+}