RoyalTerminal/.github/workflows/docs.yml at main · royalapplications/RoyalTerminal · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
name: Docs

on:
  pull_request:
    branches: [main]
    paths:
      - "docs/**"
      - "src/**"
      - "Directory.Build.props"
      - "Directory.Packages.props"
      - "RoyalTerminal.slnx"
      - "dotnet-tools.json"
      - "package.json"
      - "package-lock.json"
      - ".github/workflows/docs.yml"
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "src/**"
      - "Directory.Build.props"
      - "Directory.Packages.props"
      - "RoyalTerminal.slnx"
      - "dotnet-tools.json"
      - "package.json"
      - "package-lock.json"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

permissions:
  contents: read

env:
  DOTNET_NUGET_SIGNATURE_VERIFICATION: false

concurrency:
  group: docs-pages
  cancel-in-progress: false

jobs:
  build:
    name: Build Docs
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7
        with:
          fetch-depth: 0

      - name: Setup Node
        uses: actions/setup-node@v6
        with:
          node-version: 24
          cache: npm

      - name: Setup .NET
        uses: actions/setup-dotnet@v5
        with:
          dotnet-version: 10.0.x

      - name: Setup Pages
        if: github.event_name != 'pull_request' && vars.DOCS_DEPLOY_ENABLED == 'true'
        uses: actions/configure-pages@v6

      - name: Install dependencies
        run: npm ci

      - name: Build with VitePress
        run: npm run docs:build

      - name: Upload Pages artifact
        if: github.event_name != 'pull_request' && vars.DOCS_DEPLOY_ENABLED == 'true'
        uses: actions/upload-pages-artifact@v5
        with:
          path: docs/.vitepress/dist

  deploy:
    if: github.event_name != 'pull_request' && vars.DOCS_DEPLOY_ENABLED == 'true'
    name: Deploy Docs
    needs: build
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5