chore: validate urls in Markdown files (cypress-io#136)

* validate urls in Markdown files

* only run npm publish job on master branch

* simpler find command

* move branches to workflow section

* for the right job

Author: bahmutov

.circleci/config.yml

@@ -1,3 +1,4 @@
+# https://circleci.com/docs/2.0/configuration-reference/
 version: 2.1
 orbs:
   cypress: cypress-io/[email protected] # used to run e2e tests
@@ -18,7 +19,9 @@ jobs:
 workflows:
   build:
     jobs:
-      - cypress/install
+      - cypress/install:
+          post-steps:
+            - run: npm run check:markdown
       - cypress/run:
           name: frontend coverage
           requires:
@@ -66,6 +69,10 @@ workflows:
             - run: npx nyc report --check-coverage true --lines 100 --include test-backend/index.js
 
       - publish:
+          filters:
+            branches:
+              only:
+                - master
           requires:
             - frontend coverage
             - backend coverage

README.md

@@ -319,9 +319,17 @@ npx nyc report --check-coverage true --lines 100 --include cypress/about.js
 npx nyc report --check-coverage true --lines 100 --include cypress/unit.js
 ```
 
+### Markdown
+
+You can validate links in Markdown files in this directory by executing (Linux + Mac only) script
+
+```shell
+npm run check:markdown
+```
+
 ## License
 
-This project is licensed under the terms of the [MIT license](/LICENSE.md).
+This project is licensed under the terms of the [MIT license](LICENSE.md).
 
 [renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
 [renovate-app]: https://renovateapp.com/

package-lock.json

@@ -15,7 +15,8 @@
     "format": "prettier --write '*.js'",
     "start:test:backend": "nyc --silent node test-backend",
     "cy:backend": "cypress open --config-file cypress-backend.json",
-    "dev:backend": "start-test start:test:backend 3003 cy:backend"
+    "dev:backend": "start-test start:test:backend 3003 cy:backend",
+    "check:markdown": "find *.md -exec npx markdown-link-check {} \\;"
   },
   "peerDependencies": {
     "cypress": "*",
@@ -59,6 +60,7 @@
     "express": "4.17.1",
     "istanbul-lib-coverage": "3.0.0",
     "lodash": "4.17.15",
+    "markdown-link-check": "3.8.0",
     "nyc": "15.0.0",
     "parcel-bundler": "1.12.4",
     "prettier": "1.19.1",