.github/workflows/users-guide.yml

   1 # Adapted from agda/agda/.github/workflows/user-manual.yml by Andreas, 2021-09-11
   2
   3 name: Users guide
   4
   5 # See: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#concurrency.
   6 concurrency:
   7   group: ${{ github.ref }}-${{ github.workflow }}
   8   cancel-in-progress: true
   9
  10 on:
  11   push:
  12     branches:
  13     - master
  14     paths:
  15     - 'doc/Makefile'
  16     - 'doc/pyproject.toml'
  17     - 'doc/requirements.in'
  18     - 'doc/requirements.txt'
  19     - 'doc/*.inc'
  20     - 'doc/*.py'
  21     - 'doc/*.rst'
  22     - 'doc/**/*.json'
  23     - '.github/workflows/users-guide.yml'
  24   pull_request:
  25     paths:
  26     - 'doc/Makefile'
  27     - 'doc/pyproject.toml'
  28     - 'doc/requirements.in'
  29     - 'doc/requirements.txt'
  30     - 'doc/*.inc'
  31     - 'doc/*.py'
  32     - 'doc/*.rst'
  33     - 'doc/**/*.json'
  34     - '.github/workflows/users-guide.yml'
  35   release:
  36     types:
  37       - created
  38
  39 defaults:
  40   run:
  41     shell: bash
  42
  43 jobs:
  44   build:
  45     runs-on: ubuntu-latest
  46     strategy:
  47       matrix:
  48         python-version: [3.7]
  49
  50     steps:
  51     - uses: actions/checkout@v2
  52       with:
  53         submodules: recursive
  54
  55     - name: Set up Python ${{ matrix.python-version }}
  56       uses: actions/setup-python@v2
  57       with:
  58         python-version: ${{ matrix.python-version }}
  59
  60     # Subsumed by make users-guide
  61     # - name: Install dependencies
  62     #   run: |
  63     #     pip install -r doc/requirements.txt
  64
  65     - name: Build User's Guide in HTML
  66       run: |
  67         make SPHINX_HTML_OUTDIR=html users-guide
  68
  69     - uses: actions/upload-artifact@v2
  70       with:
  71         name: users-guide-html
  72         path: html/
  73
  74     - name: Check security of requirements.txt
  75       env:
  76         SKJOLD_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  77       run: |
  78         make -C doc check-requirements