go-car/.github/workflows/sourcey-docs.yml at 718bb249fe4d82b4f45d213615779059472524f2 · q10283245/go-car · 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
name: Sourcey Docs

on:
  pull_request:
    paths:
      - '.github/workflows/sourcey-docs.yml'
      - 'docs/sourcey/**'
      - '**/*.go'
      - 'go.mod'
      - 'v2/go.mod'
  push:
    branches: [master]
    paths:
      - '.github/workflows/sourcey-docs.yml'
      - 'docs/sourcey/**'
      - '**/*.go'
      - 'go.mod'
      - 'v2/go.mod'
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: sourcey-docs-${{ github.event_name }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build:
    name: Build documentation
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6
      - name: Set up Go
        uses: actions/setup-go@v6
        with:
          go-version: '1.25.x'
      - name: Set up Node.js
        uses: actions/setup-node@v6
        with:
          node-version: '22'
          cache: npm
          cache-dependency-path: docs/sourcey/package-lock.json
      - name: Install pinned dependencies
        run: npm ci
        working-directory: docs/sourcey
      - name: Build Sourcey site
        run: npm run build
        working-directory: docs/sourcey
      - name: Upload documentation artifact
        if: github.event_name != 'pull_request'
        uses: actions/upload-pages-artifact@v4
        with:
          path: docs/sourcey/dist

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