docs: updated typo in getting started (#97) #34
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build & Deploy Docs | |
on: | |
push: | |
branches: [main, ci] | |
workflow_dispatch: | |
env: | |
SAMPLE_APP_PATH: 'apps/sample-app' | |
jobs: | |
build-docs: | |
name: Build Docs | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Setup Node.js | |
uses: actions/setup-node@v4 | |
with: | |
node-version: 'lts/iron' | |
- name: Enable corepack | |
run: corepack enable | |
- name: Install dependencies | |
run: yarn install | |
- name: Build repo | |
run: yarn build | |
- name: Build docs | |
run: yarn workspace docs build | |
- name: Upload Build Artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: docs/build | |
deploy-docs: | |
name: Deploy Docs | |
needs: build-docs | |
# 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 |