Skip to content

Regenerate the docs

Regenerate the docs #7

Workflow file for this run

name: Check Jsonnet
on:
push:
branches: ["**"]
paths: ["**/*.libsonnet"]
jobs:
verify:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Setup Go (for Jsonnet tools)
uses: actions/setup-go@v2
with:
go-version: '1.17'
- name: Install Jsonnet tools
run: |
export GO111MODULE=on
go install github.com/google/go-jsonnet/cmd/jsonnetfmt@latest
go install github.com/google/go-jsonnet/cmd/jsonnet-lint@latest
- name: Lint Jsonnet
working-directory: fiberplane-templates
run: jsonnet-lint fiberplane.libsonnet
- name: Check Jsonnet format
working-directory: fiberplane-templates
run: |
jsonnetfmt -i fiberplane.libsonnet
if ! git diff --quiet fiberplane.libsonnet ; then
echo "::error file=fiberplane.libsonnet::Bad Jsonnet format. Run jsonnetfmt -i fiberplane.libsonnet or use one of the editor extensions to format it automatically: https://jsonnet.org/learning/tools.html";
git diff;
exit 1;
fi
- name: Verify template docs
run: |
scripts/generate_template_docs.sh
if ! git diff --quiet fiberplane-templates/docs/template_api.md ; then
echo "::error file=fiberplane-templates/docs/template_api.md::Out of date documentation, did you forgot to regenerate it?";
git diff;
exit 1;
fi