JD.MSBuild.Containers/.github/workflows/docs.yml at main · JerrettDavis/JD.MSBuild.Containers · 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
name: Documentation

on:
  push:
    branches: [ main ]
    paths:
      - 'docs/**'
      - 'src/**/*.cs'
      - '.github/workflows/docs.yml'
  pull_request:
    branches: [ main ]
    paths:
      - 'docs/**'
      - 'src/**/*.cs'
  workflow_dispatch:

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

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  build-docs:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v7

      - name: Setup .NET
        uses: actions/setup-dotnet@v6
        with:
          dotnet-version: 8.0.x

      - name: Install DocFX
        run: dotnet tool install -g docfx

      - name: Build Projects (for XML documentation)
        run: dotnet build src/JD.MSBuild.Containers.Tasks/JD.MSBuild.Containers.Tasks.csproj --configuration Release

      - name: Build Documentation
        run: |
          cd docs
          docfx docfx.json

      - name: Upload Documentation Artifact
        uses: actions/upload-artifact@v7
        with:
          name: documentation-site
          path: docs/_site

  deploy-docs:
    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
    needs: build-docs
    runs-on: ubuntu-latest

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - name: Download Documentation Artifact
        uses: actions/download-artifact@v8.0.1
        with:
          name: documentation-site
          path: _site

      - name: Setup Pages
        uses: actions/configure-pages@v6

      - name: Upload to GitHub Pages
        uses: actions/upload-pages-artifact@v5
        with:
          path: _site

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5