winutil/.github/workflows/docs.yaml at main · ChrisTitusTech/winutil · 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
109
110
111
112
113
114
115
116
117
118
119
120
name: Deploy Hugo site to Pages

on:
  push:
    branches:
      - main
    paths:
      - "docs/**"
      - "config/tweaks.json"
      - "config/feature.json"
      - "functions/**"
  workflow_dispatch:

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

concurrency:
  group: "pages"
  cancel-in-progress: false

defaults:
  run:
    shell: bash

jobs:
  build:
    if: github.repository == 'ChrisTitusTech/winutil'
    runs-on: ubuntu-latest
    env:
      HUGO_VERSION: 0.156.0
      HUGO_ENVIRONMENT: production
      TZ: America/Chicago
    steps:
      - name: Install Hugo CLI
        run: |
          wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
          && sudo dpkg -i ${{ runner.temp }}/hugo.deb
      - name: Checkout
        uses: actions/checkout@v6
        with:
          submodules: recursive
          fetch-depth: 0
          persist-credentials: false
      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v5

      - name: Generate Dev Docs from JSON
        shell: pwsh
        run: |
          Set-Location tools
          ./devdocs-generator.ps1

      - name: Create Pull Request
        id: cpr
        uses: peter-evans/create-pull-request@v8
        with:
          token: ${{ secrets.AUTO_MERGE }}
          commit-message: 'chore: Update generated dev docs'
          title: 'chore: Update Generated Dev Docs'
          body: 'Automated update of generated documentation from JSON sources'
          branch: docs-update
          delete-branch: true
          add-paths: |
            docs/content/dev/
            config/tweaks.json
            config/feature.json
          labels: |
            automated
            documentation

      - name: Check outputs
        run: |
          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
          echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"

      - name: Install Node.js dependencies
        run: "cd docs && [[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
      - name: Cache Restore
        id: cache-restore
        uses: actions/cache/restore@v5
        with:
          path: |
            ${{ runner.temp }}/hugo_cache
          key: hugo-${{ github.run_id }}
          restore-keys: hugo-
      - name: Build with Hugo
        run: |
          hugo \
            --gc \
            --minify \
            --cleanDestinationDir \
            --source docs \
            --cacheDir "${{ runner.temp }}/hugo_cache"
      - name: Cache Save
        id: cache-save
        uses: actions/cache/save@v5
        with:
          path: |
            ${{ runner.temp }}/hugo_cache
          key: ${{ steps.cache-restore.outputs.cache-primary-key }}
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: ./docs/public

  deploy:
    if: github.repository == 'ChrisTitusTech/winutil'
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4