.github: ensure docs are up to date in CI

This commit updates the CI configuration for Kilo to ensure that the
documentation, specifically the generated docs, are up-to-date.

Signed-off-by: Lucas Servén Marín <lserven@gmail.com>
This commit is contained in:
Lucas Servén Marín 2022-04-20 16:11:07 +02:00
parent 7985ed5091
commit a385f1ac82
No known key found for this signature in database
GPG Key ID: 586FEAF680DA74AD
2 changed files with 14 additions and 1 deletions

View File

@ -36,6 +36,19 @@ jobs:
- name: Build - name: Build
run: make run: make
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Go
uses: actions/setup-go@v2
with:
go-version: 1.17.1
- name: Build docs
run: |
make gen-docs
git diff --exit-code
linux: linux:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:

View File

@ -139,7 +139,7 @@ pkg/k8s/listers/kilo/v1alpha1/peer.go: .header pkg/k8s/apis/kilo/v1alpha1/types.
rm -r github.com || true rm -r github.com || true
go fmt ./pkg/k8s/listers/... go fmt ./pkg/k8s/listers/...
gen-docs: generate docs/api.md gen-docs: generate docs/api.md docs/kg.md
docs/api.md: pkg/k8s/apis/kilo/v1alpha1/types.go $(DOCS_GEN_BINARY) docs/api.md: pkg/k8s/apis/kilo/v1alpha1/types.go $(DOCS_GEN_BINARY)
$(DOCS_GEN_BINARY) $< > $@ $(DOCS_GEN_BINARY) $< > $@