docs: versioning (#455)

* docs: versioning

* update label

* reorder

* try fix

* try fix 2

* try fix

* reorder steps

* add docs folder to check

* *

.github/workflows/build-docs.yml

@@ -0,0 +1,29 @@
+name: Docs build
+# This workflow runs when a PR is labeled with `docs`
+# This will check if the docs build successfully by running `npm run build`
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - release/*
+
+jobs:
+  check-docs-build:
+    name: Check docs build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+      - uses: technote-space/get-diff-action@v5
+        id: git_diff
+        with:
+          PATTERNS: |
+            docs/*
+          SUFFIX_FILTER: |
+            .md
+      - name: Install dependencies and build docs 🧱
+        run: |
+          make build-docs

.github/workflows/proto.yml

@@ -0,0 +1,30 @@
+name: Protobuf
+# Protobuf runs buf (https://buf.build/) lint and check-breakage
+# This workflow is only run when a .proto file has been changed
+on:
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@master
+      - uses: technote-space/get-diff-action@v5
+        with:
+          PATTERNS: |
+            **/**.proto
+      - name: lint
+        run: make proto-lint
+        if: env.GIT_DIFF
+  breakage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: technote-space/get-diff-action@v5
+        with:
+          PATTERNS: |
+            **/**.proto
+      - name: check-breakage
+        run: make proto-check-breaking
+        if: env.GIT_DIFF

Makefile

@@ -271,16 +271,27 @@ docs-serve:
 	yarn && \
 	yarn run serve
 
-# This builds a docs site for each branch/tag in `./docs/versions`
-# and copies each site to a version prefixed path. The last entry inside
-# the `versions` file will be the default root index.html.
-build-docs:
 # Build the site into docs/.vuepress/dist
+build-docs:
 	@$(MAKE) docs-tools-stamp && \
 	cd docs && \
 	yarn && \
 	yarn run build
-.PHONY: docs-serve build-docs
+
+# This builds a docs site for each branch/tag in `./docs/versions`
+# and copies each site to a version prefixed path. The last entry inside
+# the `versions` file will be the default root index.html.
+build-docs-versioned:
+	@$(MAKE) docs-tools-stamp && \
+	cd docs && \
+	while read -r branch path_prefix; do \
+		(git checkout $${branch} && npm install && VUEPRESS_BASE="/$${path_prefix}/" npm run build) ; \
+		mkdir -p ~/output/$${path_prefix} ; \
+		cp -r .vuepress/dist/* ~/output/$${path_prefix}/ ; \
+		cp ~/output/$${path_prefix}/index.html ~/output ; \
+	done < versions ;
+
+.PHONY: docs-serve build-docs build-docs-versioned
 
 ###############################################################################
 ###                           Tests & Simulation                            ###

docs/.vuepress/config.js

@@ -236,6 +236,10 @@ module.exports = {
       {
         "label": "main",
         "key": "main"
+      },
+      {
+        "label": "v0.5",
+        "key": "v0.5"
       }
     ],
   }

docs/versions

@@ -1 +1,2 @@
+release/v0.5.x    v0.5
 main              main