aboutsummaryrefslogtreecommitdiffstats
path: root/.github/workflows/docs.yml
blob: e659d8e48be2a137f2d9c36d8dad455184e99459 (plain) (blame)
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
name: Documentation

on:
  push:
    branches:
      - master

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

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

jobs:
  build:
    name: Build documentation
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v4

    - name: Setup Erlang/OTP
      uses: erlef/setup-beam@v1
      with:
        otp-version: '27'
        rebar3-version: '3.23'

    - name: Restore dependencies cache
      uses: actions/cache@v4
      with:
        path: |
          _build
          rebar.lock
        key: ${{ runner.os }}-rebar3-${{ hashFiles('rebar.config') }}
        restore-keys: |
          ${{ runner.os }}-rebar3-

    - name: Compile
      run: rebar3 compile

    - name: Generate EDoc
      run: rebar3 edoc

    - name: Setup Pages
      uses: actions/configure-pages@v4

    - name: Upload artifact
      uses: actions/upload-pages-artifact@v3
      with:
        path: 'doc'

  deploy:
    name: Deploy to GitHub Pages
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build

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