groundcontrol/.github/workflows/docs.yml at master · Robiotec/groundcontrol · 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
name: Docs

on:
  push:
    branches:
      - master
      - 'Stable*'
    paths:
      - 'docs/**'
      - 'package*.json'
  pull_request:
    paths:
      - 'docs/**'
      - 'package*.json'
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

permissions:
  contents: read

env:
  BRANCH_NAME: ${{ github.head_ref || github.ref_name }}

jobs:
  build:
    runs-on: ubuntu-latest
    timeout-minutes: 15
    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@v2
        with:
          egress-policy: audit

      - name: Checkout
        uses: actions/checkout@v7
        with:
          persist-credentials: false

      - name: Setup Node
        uses: actions/setup-node@v7
        with:
          node-version: 'lts/*'

      - name: Install dependencies
        run: npm ci

      - name: Build with VitePress
        run: |
          npm run docs:build
          touch docs/.vitepress/dist/.nojekyll

      - name: Upload artifact
        uses: actions/upload-artifact@v7
        with:
          name: qgc_docs_build
          path: docs/.vitepress/dist/
          retention-days: 1

  deploy:
    if: (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && github.repository_owner == 'mavlink'
    needs: build
    runs-on: ubuntu-latest
    timeout-minutes: 15

    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@v2
        with:
          egress-policy: audit

      - name: Checkout
        uses: actions/checkout@v7
        with:
          sparse-checkout: |
            .github/actions
            .github/scripts
            tools/common
          persist-credentials: false

      - name: Deploy docs
        uses: ./.github/actions/deploy-docs
        with:
          artifact-name: qgc_docs_build
          target-repo: mavlink/docs.qgroundcontrol.com
          target-branch: master
          deploy-token: ${{ secrets.PX4BUILDBOT_ACCESSTOKEN }}
          source-branch: ${{ env.BRANCH_NAME }}
          commit-message: 'QGC docs build update'