Skip to content

Commit f36e0ef

Browse files
committedOct 31, 2022
chore: Add actions deploy
1 parent c72bdc8 commit f36e0ef

File tree

3 files changed

+62
-3
lines changed

3 files changed

+62
-3
lines changed
 

‎.github/workflows/docs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
- uses: actions/setup-node@v3
2222
name: Setup node
2323
with:
24-
node-version: '16'
24+
node-version: '18'
2525
- run: npm install -g cspell
2626
name: Install cSpell
2727
- run: cspell --config ./cSpell.json "packages/mermaid/src/docs/**/*.md" --no-progress

‎.github/workflows/publish-docs.yml

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Deploy Vitepress docs to Pages
2+
3+
on:
4+
# Runs on pushes targeting the default branch
5+
push:
6+
branches:
7+
- master
8+
9+
# Allows you to run this workflow manually from the Actions tab
10+
workflow_dispatch:
11+
12+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
# Allow one concurrent deployment
19+
concurrency:
20+
group: 'pages'
21+
cancel-in-progress: true
22+
23+
jobs:
24+
# Build job
25+
build:
26+
runs-on: ubuntu-latest
27+
steps:
28+
- name: Checkout
29+
uses: actions/checkout@v3
30+
- name: Setup Node.js
31+
uses: actions/setup-node@v3
32+
with:
33+
cache: pnpm
34+
node-version: 18
35+
36+
- name: Install Packages
37+
run: pnpm install --frozen-lockfile
38+
39+
- name: Setup Pages
40+
uses: actions/configure-pages@v2
41+
42+
- name: Run Build
43+
run: pnpm --filter mermaid run docs:build:vitepress
44+
45+
- name: Upload artifact
46+
uses: actions/upload-pages-artifact@v1
47+
with:
48+
path: packages/mermaid/src/vitepress/.vitepress/dist
49+
50+
# Deployment job
51+
deploy:
52+
environment:
53+
name: github-pages
54+
runs-on: ubuntu-latest
55+
needs: build
56+
steps:
57+
- name: Deploy to GitHub Pages
58+
id: deployment
59+
uses: actions/deploy-pages@v1

‎packages/mermaid/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
"dev": "node .esbuild/serve.cjs",
3434
"docs:code": "typedoc --plugin typedoc-plugin-markdown --readme none --githubPages false --hideBreadcrumbs --gitRemote disable --hideInPageTOC --namedAnchors --out src/docs/config/setup --entryPointStrategy expand src/defaultConfig.ts src/config.ts src/mermaidAPI.ts && prettier --write ./src/docs/config/setup",
3535
"docs:build": "rimraf ../../docs && pnpm docs:code && ts-node-esm src/docs.mts",
36-
"docs:verify": "ts-node-esm src/docs.mts --verify",
36+
"docs:verify": "pnpm docs:code && ts-node-esm src/docs.mts --verify",
3737
"docs:pre:vitepress": "rimraf src/vitepress && pnpm docs:code && ts-node-esm src/docs.mts --vitepress",
3838
"docs:build:vitepress": "pnpm docs:pre:vitepress && vitepress build src/vitepress",
3939
"docs:dev": "pnpm docs:pre:vitepress && vitepress dev src/vitepress",
@@ -138,4 +138,4 @@
138138
"**/*.css",
139139
"**/*.scss"
140140
]
141-
}
141+
}

0 commit comments

Comments
 (0)
Please sign in to comment.