.github/workflows/users-guide.yml

   1 # Adapted from agda/agda/.github/workflows/user-manual.yml by Andreas, 2021-09-11
   2
   3 name: Assorted
   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     name: Users guide
  46     runs-on: ubuntu-latest
  47     strategy:
  48       matrix:
  49         python-version: ['3.10']
  50
  51     steps:
  52     - uses: actions/checkout@v4
  53       with:
  54         submodules: recursive
  55
  56     - name: Set up Python ${{ matrix.python-version }}
  57       uses: actions/setup-python@v4
  58       with:
  59         python-version: ${{ matrix.python-version }}
  60
  61     # Subsumed by make users-guide
  62     # - name: Install dependencies
  63     #   run: |
  64     #     pip install -r doc/requirements.txt
  65
  66     - name: Build User's Guide in HTML
  67       run: |
  68         make SPHINX_HTML_OUTDIR=html users-guide
  69
  70     - uses: actions/upload-artifact@v3
  71       with:
  72         name: users-guide-html
  73         path: html/
  74
  75     - name: Check security of requirements.txt
  76       env:
  77         SKJOLD_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  78       run: |
  79         make -C doc check-requirements