.github/workflows/docs.yml

   1 name: Make sure docs are updated
   2 on:
   3   pull_request:
   4     paths:
   5       - src/main/fc/settings.yaml
   6       - docs/Settings.md
   7   push:
   8     paths:
   9       - src/main/fc/settings.yaml
  10       - docs/Settings.md
  11
  12 jobs:
  13   settings_md:
  14     runs-on: ubuntu-latest
  15
  16     steps:
  17       - uses: actions/checkout@v4
  18       - name: Install dependencies
  19         run: sudo apt-get update && sudo apt-get -y install python3-yaml
  20       - name: Check that Settings.md is up to date
  21         run: |
  22           cp docs/Settings.md{,.ci}
  23           python3 src/utils/update_cli_docs.py -q
  24           if ! diff -q docs/Settings.md{,.ci} >/dev/null; then
  25             echo "::error ::\"docs/Settings.md\" is not up to date, please run \"src/utils/update_cli_docs.py\""
  26             exit 1
  27           fi