json-api-toolkit/.github/workflows/docs.yml at main · intility/json-api-toolkit · 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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
name: "Docs: Check & Deploy"

on:
  push:
    branches:
      - main
    paths:
      - "docs/**"
      - "mkdocs.yaml"
      - "JsonApiToolkit/**"
      - ".github/workflows/docs.yml"
  pull_request:
  workflow_dispatch:

permissions:
  contents: read
  packages: read
  pages: write
  id-token: write

concurrency:
  group: pages-${{ github.event_name == 'pull_request' && github.head_ref ||
    'deploy' }}
  cancel-in-progress: true

jobs:
  changes:
    name: Detect changes
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: read
    outputs:
      docs: ${{ steps.filter.outputs.docs }}
    steps:
      - uses: dorny/paths-filter@fbd0ab8f3e69293af611ebaee6363fc25e6d187d # v4.0.1
        id: filter
        with:
          filters: |
            docs:
              - 'docs/**'
              - 'mkdocs.yaml'
              - 'CHANGELOG.md'
              - 'JsonApiToolkit/**'
              - '.github/workflows/docs.yml'

  build:
    name: "Docs: Build"
    needs: changes
    if: always() && (needs.changes.result == 'skipped' || needs.changes.outputs.docs
      == 'true')
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
        with:
          fetch-depth: 0

      - uses: actions/setup-dotnet@c2fa09f4bde5ebb9d1777cf28262a3eb3db3ced7 # v5
        with:
          dotnet-version: 10.0.x
          source-url: https://nuget.pkg.github.com/Intility/index.json
        env:
          NUGET_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
        with:
          python-version: "3.13"

      - name: Build library (for API XML docs)
        env:
          NUGET_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: dotnet build JsonApiToolkit/JsonApiToolkit.csproj -c Release -o
          JsonApiToolkit/bin/docs

      - name: Install Intility.DotnetApiDocs
        env:
          NUGET_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: dotnet tool install -g Intility.DotnetApiDocs --version 0.1.5

      - name: Generate API reference
        run: dotnet-api-docs --input JsonApiToolkit/bin/docs --output docs/api --strict

      - name: Install Python dependencies
        run: uv venv && uv pip install -r docs/requirements.txt

      - name: Build Documentation
        run: uv run mkdocs build --strict

      - name: Upload artifact
        if: github.event_name != 'pull_request'
        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
        with:
          path: "site"

  deploy:
    name: Deploy
    if: always() && needs.build.result == 'success' && github.event_name !=
      'pull_request'
    runs-on: ubuntu-latest
    needs: build
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0