diff options
| author | Dave Henderson <dhenderson@gmail.com> | 2024-05-12 13:54:28 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-12 13:54:28 -0400 |
| commit | edaf202f95bd52c35ba54c54452e8940002cf897 (patch) | |
| tree | d605df822eec1011f99afbc22e02ba640b7a06d2 /.github | |
| parent | 607d4a66e3e9c525f0dfbbc71a9f9bc3f9bdbb38 (diff) | |
ci(docs): Require up-to-date function docs (#2071)
* ci(docs): Require up-to-date function docs
Signed-off-by: Dave Henderson <dhenderson@gmail.com>
* docs(fix): update regenerated docs
Signed-off-by: Dave Henderson <dhenderson@gmail.com>
---------
Signed-off-by: Dave Henderson <dhenderson@gmail.com>
Diffstat (limited to '.github')
| -rw-r--r-- | .github/workflows/docs.yml | 23 |
1 files changed, 23 insertions, 0 deletions
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 |