mlango/.github/workflows/docs.yml at master · DrobyshevDev/mlango · 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
name: Publish documentation

on:
  push:
    branches: [master]
    paths:
      - "docs/**"
      - "mkdocs.yml"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

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

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

jobs:
  build:
    name: Build the site
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7
        with:
          python-version: "3.12"
          cache: pip
      - run: pip install mkdocs-material mkdocs-static-i18n

      # Always built, even while the site cannot be published: --strict is what
      # catches a broken link or a missing translation, and that check is worth
      # having on every push regardless of where the output goes.
      - run: mkdocs build --strict

      # Pages needs enabling on the repository, which a private repository
      # cannot do without a paid plan. Skipped rather than left failing; it
      # begins publishing on its own once the repository is public.
      - uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6
        if: github.event.repository.visibility == 'public'
      - uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5
        if: github.event.repository.visibility == 'public'
        with:
          path: site

  deploy:
    name: Deploy to Pages
    needs: build
    if: github.event.repository.visibility == 'public'
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5