bedrock/.github/workflows/publish_docs.yml at main · dveditz/bedrock · 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
name: Publish documentation

on:
  workflow_dispatch: # allow manual runs
  push:
    branches:
      - main
    paths: # only build on relevant changes
      - docs/**
      - requirements/docs.*
      - .github/workflows/publish_docs.yml

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

concurrency:
  group: github-pages
  cancel-in-progress: false # skip any intermediate builds but let finish

jobs:
  build:
    if: github.repository == 'mozilla/bedrock'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: 3.13
          cache: pip
      - id: pages
        uses: actions/configure-pages@v5
      - run: pip install -r requirements/docs.txt
      - run: cd docs && mkdocs build -d site
      - uses: actions/upload-pages-artifact@v3
        with:
          path: ./docs/site
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - id: deployment
        uses: actions/deploy-pages@v4