mirror of
https://github.com/wavetermdev/waveterm.git
synced 2025-01-08 19:38:51 +01:00
edb3290349
## Summary We are moving our docsite to this repo for better coordination. ## What's changed? - The docsite codebase is now in docs/ - The docsite will replace storybook as the published GitHub Pages site for this repo - Storybook will now be hosted at https://docs.waveterm.dev/storybook - A new CI workflow will validate any changes to Storybook or the docsite - A combined CD workflow will build and deploy Storybook and the docsite as a single artifact - The Build Helper workflow will now build an embedded version of the docsite before building the app, ensuring the docsite version it has is always the latest
60 lines
1.8 KiB
YAML
60 lines
1.8 KiB
YAML
name: Deploy Docsite and Storybook
|
|
|
|
env:
|
|
NODE_VERSION: 20
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
# Review gh actions docs if you want to further define triggers, paths, etc
|
|
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
build:
|
|
name: Build Docsite
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
- uses: actions/setup-node@v4
|
|
with:
|
|
node-version: ${{env.NODE_VERSION}}
|
|
- name: Install yarn
|
|
run: |
|
|
corepack enable
|
|
yarn install
|
|
- name: Build docsite
|
|
run: yarn build
|
|
working-directory: docs/
|
|
|
|
- name: Build Storybook
|
|
run: yarn build-storybook
|
|
working-directory: storybook/
|
|
- name: Copy Storybook to docs
|
|
run: cp -r storybook-static docs/build/storybook
|
|
- name: Upload Build Artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: docs/build
|
|
deploy:
|
|
name: Deploy to GitHub Pages
|
|
needs: build
|
|
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
|
|
permissions:
|
|
pages: write # to deploy to Pages
|
|
id-token: write # to verify the deployment originates from an appropriate source
|
|
|
|
# Deploy to the github-pages environment
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v4
|