Update generated documentation (#4075) #52
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Deploy Hugo site to Pages | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - "docs/**" | |
| - "config/tweaks.json" | |
| - "config/feature.json" | |
| - "functions/**" | |
| workflow_dispatch: | |
| permissions: | |
| contents: write | |
| 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.147.7 | |
| 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@v6 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| commit-message: 'Update generated documentation' | |
| title: 'chore: Update Generated Dev Docs' | |
| body: 'Automated update of generated documentation from JSON sources' | |
| branch: docs-update | |
| delete-branch: true | |
| labels: automated | |
| - 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 |