Skip to content

Merge pull request #6291 from sircharlo/dependabot/npm_and_yarn/music… #1561

Merge pull request #6291 from sircharlo/dependabot/npm_and_yarn/music…

Merge pull request #6291 from sircharlo/dependabot/npm_and_yarn/music… #1561

Workflow file for this run

name: Deploy Docs site to Pages
on:
release:
types: [released]
push:
branches:
- master
paths:
- docs/**
- src/constants/locales.ts
- package.json
- yarn.lock
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Check out Git repository
uses: actions/checkout@v6
- name: Setup Node
uses: actions/setup-node@v6
with:
node-version: 22
cache: 'yarn'
- name: Install dependencies
run: yarn install
- name: Prepare Quasar (generate .quasar/tsconfig.json)
run: yarn quasar prepare
- name: Lint files
run: yarn docs:lint
fix-links:
runs-on: ubuntu-latest
steps:
- name: Check out Git repository
uses: actions/checkout@v6
with:
token: ${{ secrets.GITHUB_TOKEN }}
ref: ${{ github.head_ref || github.ref_name }}
- name: Setup Node
uses: actions/setup-node@v6
with:
node-version: 22
cache: 'yarn'
- name: Install dependencies
run: yarn install
- name: Fix documentation links
run: yarn docs:fix-links
- name: Commit and push fixes
run: |
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git add docs/src/
if git diff --staged --quiet; then
echo "No link fixes needed"
else
git commit -m "fix: automatically fix documentation links [skip ci]"
git push origin HEAD:${{ github.head_ref || github.ref_name }}
fi
test:
runs-on: ubuntu-latest
needs: fix-links
steps:
- name: Check out Git repository
uses: actions/checkout@v6
- name: Setup Node
uses: actions/setup-node@v6
with:
node-version: 22
cache: 'yarn'
- name: Install dependencies
run: yarn install
- name: Run tests
run: |
yarn quasar prepare
yarn docs:test
build:
runs-on: ubuntu-latest
needs: [lint, test]
steps:
- name: Checkout
uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Setup Node
uses: actions/setup-node@v6
with:
node-version: 22
cache: 'yarn'
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Install dependencies
run: yarn install
- name: Prepare Quasar (generate .quasar/tsconfig.json)
run: yarn quasar prepare
- name: Build with VitePress
run: |
yarn generate:logos
yarn docs:build
- name: Upload dist artifacts
uses: actions/upload-artifact@v6
with:
name: dist
path: docs/.vitepress/dist
- name: Upload page artifact
uses: actions/upload-pages-artifact@v4
with:
path: docs/.vitepress/dist
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