cse-student-starter-guide/.github/workflows/doc.yml at main · CodeCompasss/cse-student-starter-guide · 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
name: Docs

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.ref != 'refs/heads/dev' }}

on:
  workflow_dispatch:
  push:
    branches:
      - main
      - dev

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

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

    runs-on: ubuntu-latest

    steps:
      # 1. Checkout the repository
      - name: Checkout
        uses: actions/checkout@v4


      # 3. Setup Python
      - uses: actions/setup-python@v5
        with:
          python-version: '3.x'

      # 4. Generate Docs (inline MkDocs build)
      - name: Generate Docs
        run: |
          set -ex
          python3 -m venv venv
          source venv/bin/activate
          pip install --upgrade pip
          pip install mkdocs mkdocs-material mkdocs-redirects \
                      mkdocs-minify-plugin mkdocs-awesome-pages-plugin \
                      mkdocs-macros-plugin mkdocs-codeinclude-plugin
          mkdocs build --clean
          deactivate

      # 4. Configure GitHub Pages
      - name: Setup Pages
        uses: actions/configure-pages@v4

      # 5. Upload Pages Artifact
      - name: Upload Pages Artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: './site'

      # 6. Deploy to GitHub Pages
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4