From edaf202f95bd52c35ba54c54452e8940002cf897 Mon Sep 17 00:00:00 2001 From: Dave Henderson Date: Sun, 12 May 2024 13:54:28 -0400 Subject: ci(docs): Require up-to-date function docs (#2071) * ci(docs): Require up-to-date function docs Signed-off-by: Dave Henderson * docs(fix): update regenerated docs Signed-off-by: Dave Henderson --------- Signed-off-by: Dave Henderson --- .github/workflows/docs.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/workflows/docs.yml (limited to '.github') diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..7ce346d9 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,23 @@ +name: Docs Checks +on: + pull_request: + branches: [ main ] + +jobs: + check-func-docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Install gomplate + run: | + docker create --name gomplate hairyhenderson/gomplate + docker cp gomplate:/gomplate . + sudo mv gomplate /usr/local/bin + - name: Make sure function docs are up-to-date + run: | + make --always-make gen-func-docs + git diff --exit-code + if [ $? -ne 0 ]; then + echo "Function docs are out of date. Please run 'make gen-func-docs' locally and commit the changes." + exit 1 + fi -- cgit v1.2.3