SimpleLauncher/.github/workflows/docs.yml at master · purelogiccode/SimpleLauncher · 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
name: Docs

# Publishes docs/ to GitHub Pages (docsify site) and syncs docs/ to the GitHub wiki.
# Wiki sync needs the WIKI_PAT secret (classic PAT, repo scope); without it the wiki
# job warns and skips. Pages requires Settings -> Pages -> Source = GitHub Actions.

on:
  push:
    branches:
      - master
    paths:
      - 'docs/**'
      - 'scripts/sync-wiki.py'
      - '.github/workflows/docs.yml'
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: docs
  cancel-in-progress: false

jobs:
  pages:
    name: Deploy GitHub Pages
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Checkout
        uses: actions/checkout@v7

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

      - name: Upload site
        uses: actions/upload-pages-artifact@v5
        with:
          path: docs
          include-hidden-files: true

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

  wiki:
    name: Sync wiki
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7

      - name: Set up Python
        uses: actions/setup-python@v7
        with:
          python-version: '3.x'

      - name: Sync docs to the wiki
        env:
          WIKI_PAT: ${{ secrets.WIKI_PAT }}
          GIT_TERMINAL_PROMPT: '0'
        run: |
          if [ -z "$WIKI_PAT" ]; then
            echo "::warning::WIKI_PAT secret is not set - skipping the wiki sync."
            exit 0
          fi
          git config --global user.name 'github-actions[bot]'
          git config --global user.email '41898282+github-actions[bot]@users.noreply.github.com'
          git config --global url."https://x-access-token:${WIKI_PAT}@github.com/".insteadOf "https://github.com/"
          python scripts/sync-wiki.py