document configuration for v10+ (#133)

* document configuration for v10+

* update actions

Author: bahmutov

.github/workflows/badges.yml

@@ -12,10 +12,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Update version badges 🏷
-        run: npx -p dependency-version-badge update-badge cypress @bahmutov/cypress-fiddle
+        run: npm run badges
 
       - name: Commit any changed files 💾
         uses: stefanzweifel/git-auto-commit-action@v4

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout 🛎
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       # Node > 16
       # npm > 8
@@ -15,7 +15,7 @@ jobs:
           npm -v
 
       - name: Run tests 🧪
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v5
         with:
           command: npm t
 
@@ -26,7 +26,8 @@ jobs:
           # TODO: confirm the exported JavaScript file
 
       - name: Semantic Release 🚀
-        uses: cycjimmy/semantic-release-action@v2
+        uses: cycjimmy/semantic-release-action@v3
+        if: github.ref == 'refs/heads/main'
         with:
           branch: main
         env:

README.md

@@ -16,7 +16,28 @@ npm i -D cypress-markdown-preprocessor
 yarn add -D cypress-markdown-preprocessor
 ```
 
-Add to your Cypress plugins file
+### Configure the plugin
+
+If you are using Cypress v10+, add to your Cypress plugins file
+
+```js
+// cypress.config.js
+const { defineConfig } = require('cypress')
+const mdPreprocessor = require('cypress-markdown-preprocessor')
+
+module.exports = defineConfig({
+  e2e: {
+    setupNodeEvents(on, config) {
+      on('file:preprocessor', mdPreprocessor)
+      return config
+    },
+    // use Markdown file from folder "docs" as tests
+    specPattern: 'docs/**/*.md',
+  },
+})
+```
+
+If you are using Cypress before version 10, add the following to your plugins file:
 
 ```js
 // cypress/plugins/index.js
@@ -26,7 +47,7 @@ module.exports = (on, config) => {
 }
 ```
 
-Set the [`testFiles`](https://on.cypress.io/configuration) to use Markdown files as specs
+And set the [`testFiles`](https://on.cypress.io/configuration) in file `cypress.json` to use Markdown files as specs
 
 ```json
 {

package.json

@@ -14,7 +14,8 @@
     "cy:open": "cypress open",
     "cy:run": "cypress run",
     "test": "cypress-expect run --min-passing 2",
-    "semantic-release": "semantic-release"
+    "semantic-release": "semantic-release",
+    "badges": "npx -p dependency-version-badge update-badge cypress @bahmutov/cypress-fiddle"
   },
   "repository": {
     "type": "git",