reaper/.github/workflows/docs.yml at main · miguelgila/reaper · 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
name: Documentation

on:
  push:
    branches: [main]
    paths:
      - 'docs/**'
      - 'examples/README.md'
      - '.github/workflows/docs.yml'
  pull_request:
    branches: [main]
    paths:
      - 'docs/**'
      - 'examples/README.md'
      - '.github/workflows/docs.yml'

# Allow only one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: false

# Sets permissions for GitHub Pages deployment
permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install mdBook
        uses: peaceiris/actions-mdbook@v2
        with:
          mdbook-version: 'latest'

      - name: Build documentation
        run: mdbook build docs/book

      - name: Upload artifact
        if: github.ref == 'refs/heads/main' && github.event_name == 'push'
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/book/book

  deploy:
    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Check GitHub Pages is enabled
        run: |
          echo "If this step fails with a 404, enable GitHub Pages in your repository:"
          echo "  Settings → Pages → Source: GitHub Actions"
          echo ""
          echo "See: https://github.com/miguelgila/reaper/settings/pages"

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