feat: output docs into versioned subfolder

.github/workflows/ci.yml

@@ -30,11 +30,18 @@ jobs:
       - name: Check links ⚓️
         run: npm run check:links
 
+      - name: Set Cypress version 🎁
+        id: cypress
+        run: echo "::set-output name=version::$(node ./src/print-cypress-version)"
+
+      - name: Print Cypress version 🖨
+        run: echo "Cypress version is ${{ steps.cypress.outputs.version }}"
+
       - name: Build site 🏗
         run: npm run docs:build
 
       - name: Export Markdown specs 🖨
-        run: node ./md-to-js http://localhost:5000/cypress-examples
+        run: node ./md-to-js http://localhost:5000/cypress-examples/${{ steps.cypress.outputs.version }}
 
       - name: Catch stray .only tests 🚦
         run: npm run stop-only
@@ -65,4 +72,5 @@ jobs:
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./public/cypress-examples
+          publish_dir: ./public/cypress-examples/${{ steps.cypress.outputs.version }}"
+          destination_dir: ${{ steps.cypress.outputs.version }}"

.github/workflows/pr.yml

@@ -1,4 +1,4 @@
-name: ci
+name: pr
 # test Cypress examples on every pull request
 # and make sure the site builds, but no deploy
 on: pull_request
@@ -12,6 +12,13 @@ jobs:
         with:
           persist-credentials: false
 
+      - name: Set Cypress version 🎁
+        id: cypress
+        run: echo "::set-output name=version::$(node ./src/print-cypress-version)"
+
+      - name: Print Cypress version 🖨
+        run: echo "Cypress version is ${{ steps.cypress.outputs.version }}"
+
       - name: Cypress tests 🧪
         uses: cypress-io/github-action@v2
         with:
@@ -24,7 +31,7 @@ jobs:
         run: npm run docs:build
 
       - name: Export Markdown specs 🖨
-        run: node ./md-to-js http://localhost:5000/cypress-examples
+        run: node ./md-to-js http://localhost:5000/cypress-examples/${{ steps.cypress.outputs.version }}
 
       - name: Catch stray .only tests 🚦
         run: npm run stop-only

docs/.vuepress/config.js

@@ -1,11 +1,20 @@
 let _highlight
 
+const { findCypressVersion } = require('../../src/utils')
+const path = require('path')
+
+const cypressVersion = findCypressVersion()
+const base = `/cypress-examples/${cypressVersion}/`
+const dest = path.join('public', 'cypress-examples', cypressVersion)
+console.log('output folder: %s', dest)
+const title = `Cypress examples (v${cypressVersion})`
+
 module.exports = {
-  title: 'Cypress examples',
+  title,
   description:
     'Static site with Cypress examples tested right from the Markdown sources',
-  base: '/cypress-examples/',
-  dest: 'public/cypress-examples',
+  base,
+  dest,
   head: [
     [
       'link',

docs/commands/navigation.md

@@ -64,7 +64,7 @@ To visit a remote page, use the `cy.visit()` command.
 // trick: dynamically set base url in this test only
 Cypress.config(
   'baseUrl',
-  window.location.origin + '/cypress-examples',
+  `${window.location.origin}/cypress-examples/${Cypress.version}`,
 )
 
 // Visit any sub-domain of your current domain,

md-to-js.js

@@ -1,11 +1,13 @@
 // @ts-check
 const shell = require('shelljs')
 const path = require('path')
+const { findCypressVersion } = require('./src/utils')
 
 // converts Markdown fiddle specs into JavaScript specs
 let baseUrl = process.argv[2]
 if (!baseUrl) {
-  const DEFAULT_BASE_URL = 'http://localhost:5000/cypress-examples'
+  const cypressVersion = findCypressVersion()
+  const DEFAULT_BASE_URL = `http://localhost:5000/cypress-examples/${cypressVersion}`
   console.log('Setting empty baseUrl to %s', DEFAULT_BASE_URL)
   baseUrl = DEFAULT_BASE_URL
 }