scripts/.github/workflows/documentation.yaml at master · AMTSupport/scripts · 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
name: Generate PowerShell Docs

on:
  workflow_dispatch:
  push:
    branches: [master]
    paths:
      - "docs/**"
      - "src/**"
      - "utils/Generate-Documentation.ps1"
      - ".github/workflows/documentation.yaml"

jobs:
  update_docs:
    name: Update Documentation
    runs-on: ubuntu-latest
    outputs:
      changed: ${{ steps.changes.outputs.commit.changes_detected }}
    permissions:
      contents: write
      pull-requests: write

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install Dependencies
        shell: pwsh
        run: |
          Install-Module Alt3.Docusaurus.Powershell -Scope CurrentUser -Force
          Install-Module platyPS -Scope CurrentUser -Force
          .\utils\Install-Requirements.ps1

      - name: Generate Documentation
        shell: pwsh
        run: .\utils\Generate-Documentation.ps1

      - name: Commit changes
        id: commit
        uses: stefanzweifel/git-auto-commit-action@v7
        with:
          commit_message: "chore(docs): Update documentation"

  deploy:
    name: Deploy Documentation
    runs-on: ubuntu-latest
    needs: update_docs
    if: ${{ needs.update_docs.outputs.changed == 'true' }}
    permissions:
      contents: read
      pull-requests: read

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          ref: ${{ github.ref }}

      - uses: pnpm/action-setup@v3
        with:
          version: 8
          run_install: false
          standalone: true

      - uses: actions/setup-node@v4
        with:
          node-version: latest
          cache: pnpm
          cache-dependency-path: ./docs

      - name: Install dependencies
        run: pnpm install --frozen-lockfile
        working-directory: ./docs

      - name: Build website
        run: pnpm build
        working-directory: ./docs

      - name: Deploy Documentation
        uses: peaceiris/actions-gh-pages@v3.9.3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/build
          user_name: github-actions[bot]
          user_email: 41898282+github-actions[bot]@users.noreply.github.com