From f36e0ef9414d6b74ec684da51bcf135f30bd14f6 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Mon, 31 Oct 2022 21:44:09 +0530 Subject: [PATCH] chore: Add actions deploy --- .github/workflows/docs.yml | 2 +- .github/workflows/publish-docs.yml | 59 ++++++++++++++++++++++++++++++ packages/mermaid/package.json | 4 +- 3 files changed, 62 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/publish-docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a7ad03a7a..dbdc4b904 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -21,7 +21,7 @@ jobs: - uses: actions/setup-node@v3 name: Setup node with: - node-version: '16' + node-version: '18' - run: npm install -g cspell name: Install cSpell - run: cspell --config ./cSpell.json "packages/mermaid/src/docs/**/*.md" --no-progress diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml new file mode 100644 index 000000000..da4366a85 --- /dev/null +++ b/.github/workflows/publish-docs.yml @@ -0,0 +1,59 @@ +name: Deploy Vitepress docs to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: + - master + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow one concurrent deployment +concurrency: + group: 'pages' + cancel-in-progress: true + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Setup Node.js + uses: actions/setup-node@v3 + with: + cache: pnpm + node-version: 18 + + - name: Install Packages + run: pnpm install --frozen-lockfile + + - name: Setup Pages + uses: actions/configure-pages@v2 + + - name: Run Build + run: pnpm --filter mermaid run docs:build:vitepress + + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: packages/mermaid/src/vitepress/.vitepress/dist + + # Deployment job + deploy: + environment: + name: github-pages + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 diff --git a/packages/mermaid/package.json b/packages/mermaid/package.json index a03e2fa8d..2e724d506 100644 --- a/packages/mermaid/package.json +++ b/packages/mermaid/package.json @@ -33,7 +33,7 @@ "dev": "node .esbuild/serve.cjs", "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", "docs:build": "rimraf ../../docs && pnpm docs:code && ts-node-esm src/docs.mts", - "docs:verify": "ts-node-esm src/docs.mts --verify", + "docs:verify": "pnpm docs:code && ts-node-esm src/docs.mts --verify", "docs:pre:vitepress": "rimraf src/vitepress && pnpm docs:code && ts-node-esm src/docs.mts --vitepress", "docs:build:vitepress": "pnpm docs:pre:vitepress && vitepress build src/vitepress", "docs:dev": "pnpm docs:pre:vitepress && vitepress dev src/vitepress", @@ -138,4 +138,4 @@ "**/*.css", "**/*.scss" ] -} +} \ No newline at end of file