Crypto/.github/workflows/docs.yml at e7eb71751e5115dc32327ad4df7f8888ab999400 · chapel-lang/Crypto · 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
name: build docs

on:
  push:
    branches:
      - main
  pull_request:
  workflow_dispatch:
  workflow_call:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    container:
      # TODO: use nightly to get the latest chpldoc features, switch to stable
      # when 2.9 is released
      image: chapel/chapel:nightly
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Build docs
        run: |
          # TODO: docs builds fail because of examples not being included.
          # ignore for now
          mason doc || true
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./doc/

  # TODO: where do we deploy the docs to?
  # deploy:
  #   if: github.event_name == 'push' && github.repository == 'chapel-lang/Crypto'
  #   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