4f1c052d28
Use repository name from GitHub context instead of hardcoding it to make the workflow more flexible and reusable across different repositories
64 lines
1.8 KiB
YAML
64 lines
1.8 KiB
YAML
# Sample workflow for building and deploying a VitePress site to GitHub Pages
|
|
name: Deploy VitePress site to Pages
|
|
|
|
on:
|
|
# Runs on pushes targeting the `main` branch. Change this to `master` if you're using `master` branch.
|
|
push:
|
|
branches: [main, master, version2]
|
|
|
|
# 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 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.
|
|
concurrency:
|
|
group: pages
|
|
cancel-in-progress: false
|
|
|
|
jobs:
|
|
# Build job
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0 # Not needed if lastUpdated is not enabled
|
|
- name: Setup Node
|
|
uses: actions/setup-node@v4
|
|
with:
|
|
node-version: 20
|
|
cache: npm
|
|
- name: Setup Pages
|
|
uses: actions/configure-pages@v4
|
|
- name: Install dependencies
|
|
run: npm ci
|
|
- name: Build with VitePress
|
|
run: |
|
|
REPO_NAME=$(echo '${{ github.repository }}' | awk -F '/' '{print $2}')
|
|
echo "Building for repository: $REPO_NAME"
|
|
npm run build -- --base /$REPO_NAME/
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: 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:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v4
|