docs: versioning (#455)
* docs: versioning * update label * reorder * try fix * try fix 2 * try fix * reorder steps * add docs folder to check * *
This commit is contained in:
Federico Kunze Küllmer
GitHub
parent
f34e9b5fc1
commit
1b95d06c92
29
.github/workflows/build-docs.yml
vendored
Normal file
29
.github/workflows/build-docs.yml
vendored
Normal file
@ -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/checkout@v2.3.4
|
||||
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
|
||||
30
.github/workflows/proto.yml
vendored
Normal file
30
.github/workflows/proto.yml
vendored
Normal file
@ -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
|
||||
21
Makefile
21
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 ###
|
||||
|
||||
@ -236,6 +236,10 @@ module.exports = {
|
||||
{
|
||||
"label": "main",
|
||||
"key": "main"
|
||||
},
|
||||
{
|
||||
"label": "v0.5",
|
||||
"key": "v0.5"
|
||||
}
|
||||
],
|
||||
}
|
||||
|
||||
46
docs/package-lock.json
generated
46
docs/package-lock.json
generated
@ -10,6 +10,7 @@
|
||||
"dependencies": {
|
||||
"entities": "^2.0.3",
|
||||
"markdown-it": "^12.0.6",
|
||||
"markdown-it-katex": "^2.0.3",
|
||||
"vuepress-theme-cosmos": "^1.0.182"
|
||||
},
|
||||
"devDependencies": {
|
||||
@ -7869,6 +7870,17 @@
|
||||
"promise": "^7.0.1"
|
||||
}
|
||||
},
|
||||
"node_modules/katex": {
|
||||
"version": "0.6.0",
|
||||
"resolved": "https://registry.npmjs.org/katex/-/katex-0.6.0.tgz",
|
||||
"integrity": "sha1-EkGOCRIcBckgQbazuftrqyE8tvM=",
|
||||
"dependencies": {
|
||||
"match-at": "^0.1.0"
|
||||
},
|
||||
"bin": {
|
||||
"katex": "cli.js"
|
||||
}
|
||||
},
|
||||
"node_modules/keyv": {
|
||||
"version": "3.1.0",
|
||||
"resolved": "https://registry.npmjs.org/keyv/-/keyv-3.1.0.tgz",
|
||||
@ -8189,6 +8201,14 @@
|
||||
"integrity": "sha1-m+4OmpkKljupbfaYDE/dsF37Tcw=",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/markdown-it-katex": {
|
||||
"version": "2.0.3",
|
||||
"resolved": "https://registry.npmjs.org/markdown-it-katex/-/markdown-it-katex-2.0.3.tgz",
|
||||
"integrity": "sha1-17hqGuoLnWSW+rTnkZoY/e9YnDk=",
|
||||
"dependencies": {
|
||||
"katex": "^0.6.0"
|
||||
}
|
||||
},
|
||||
"node_modules/markdown-it-table-of-contents": {
|
||||
"version": "0.4.4",
|
||||
"resolved": "https://registry.npmjs.org/markdown-it-table-of-contents/-/markdown-it-table-of-contents-0.4.4.tgz",
|
||||
@ -8219,6 +8239,11 @@
|
||||
"uc.micro": "^1.0.1"
|
||||
}
|
||||
},
|
||||
"node_modules/match-at": {
|
||||
"version": "0.1.1",
|
||||
"resolved": "https://registry.npmjs.org/match-at/-/match-at-0.1.1.tgz",
|
||||
"integrity": "sha512-h4Yd392z9mST+dzc+yjuybOGFNOZjmXIPKWjxBd1Bb23r4SmDOsk2NYCU2BMUBGbSpZqwVsZYNq26QS3xfaT3Q=="
|
||||
},
|
||||
"node_modules/md5.js": {
|
||||
"version": "1.3.5",
|
||||
"resolved": "https://registry.npmjs.org/md5.js/-/md5.js-1.3.5.tgz",
|
||||
@ -19450,6 +19475,14 @@
|
||||
"promise": "^7.0.1"
|
||||
}
|
||||
},
|
||||
"katex": {
|
||||
"version": "0.6.0",
|
||||
"resolved": "https://registry.npmjs.org/katex/-/katex-0.6.0.tgz",
|
||||
"integrity": "sha1-EkGOCRIcBckgQbazuftrqyE8tvM=",
|
||||
"requires": {
|
||||
"match-at": "^0.1.0"
|
||||
}
|
||||
},
|
||||
"keyv": {
|
||||
"version": "3.1.0",
|
||||
"resolved": "https://registry.npmjs.org/keyv/-/keyv-3.1.0.tgz",
|
||||
@ -19708,11 +19741,24 @@
|
||||
"resolved": "https://registry.npmjs.org/markdown-it-emoji/-/markdown-it-emoji-1.4.0.tgz",
|
||||
"integrity": "sha1-m+4OmpkKljupbfaYDE/dsF37Tcw="
|
||||
},
|
||||
"markdown-it-katex": {
|
||||
"version": "2.0.3",
|
||||
"resolved": "https://registry.npmjs.org/markdown-it-katex/-/markdown-it-katex-2.0.3.tgz",
|
||||
"integrity": "sha1-17hqGuoLnWSW+rTnkZoY/e9YnDk=",
|
||||
"requires": {
|
||||
"katex": "^0.6.0"
|
||||
}
|
||||
},
|
||||
"markdown-it-table-of-contents": {
|
||||
"version": "0.4.4",
|
||||
"resolved": "https://registry.npmjs.org/markdown-it-table-of-contents/-/markdown-it-table-of-contents-0.4.4.tgz",
|
||||
"integrity": "sha512-TAIHTHPwa9+ltKvKPWulm/beozQU41Ab+FIefRaQV1NRnpzwcV9QOe6wXQS5WLivm5Q/nlo0rl6laGkMDZE7Gw=="
|
||||
},
|
||||
"match-at": {
|
||||
"version": "0.1.1",
|
||||
"resolved": "https://registry.npmjs.org/match-at/-/match-at-0.1.1.tgz",
|
||||
"integrity": "sha512-h4Yd392z9mST+dzc+yjuybOGFNOZjmXIPKWjxBd1Bb23r4SmDOsk2NYCU2BMUBGbSpZqwVsZYNq26QS3xfaT3Q=="
|
||||
},
|
||||
"md5.js": {
|
||||
"version": "1.3.5",
|
||||
"resolved": "https://registry.npmjs.org/md5.js/-/md5.js-1.3.5.tgz",
|
||||
|
||||
@ -1 +1,2 @@
|
||||
release/v0.5.x v0.5
|
||||
main main
|
||||
|
||||
14045
docs/yarn.lock
14045
docs/yarn.lock
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user