Skip to content

Commit

Permalink
Update to the gh-pages.yml for github pages deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
ronitjadhav authored Jun 6, 2024
1 parent 1834399 commit e405e69
Showing 1 changed file with 23 additions and 34 deletions.
57 changes: 23 additions & 34 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -1,64 +1,53 @@
# Sample workflow for building and deploying a VitePress site to GitHub Pages
#
name: Deploy VitePress site to Pages
# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
# using the `master` branch as the default branch.
# Runs on pushes targeting the default branch
push:
branches: [main]
branches: ['main']

# 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
# Sets the GITHUB_TOKEN permissions to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
# Allow one concurrent deployment
concurrency:
group: pages
cancel-in-progress: false
group: 'pages'
cancel-in-progress: true

jobs:
# Build job
build:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Node
- name: Set up Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm
cache: 'npm'
- name: Install dependencies
run: npm ci
working-directory: apps/examples
- name: Build
run: npm run build
working-directory: apps/examples
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Change directory to apps/examples
run: cd apps/examples
- name: Install dependencies
run: npm ci
- name: Build with VitePress
run: npm run docs:build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: apps/examples/docs/.vitepress/dist

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
name: Deploy
steps:
# Upload dist folder
path: apps/examples/dist
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit e405e69

Please sign in to comment.