Skip to content

Commit

Permalink
CI / Makefile: ensure helm docs
Browse files Browse the repository at this point in the history
Signed-off-by: Federico Paolinelli <[email protected]>
  • Loading branch information
fedepaol committed Aug 31, 2023
1 parent 57aa697 commit a512ef9
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,12 @@ jobs:
make manifests
make generate-all-in-one
make checkuncommitted
- name: Helm doc generate
uses: docker://jnorwood/helm-docs:v1.10.0

- name: Check if docs are different
run: make checkuncommitted

build-test-images:
runs-on: ubuntu-22.04
Expand Down
5 changes: 5 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ GINKGO_VERSION ?= v2.11.0
KIND_VERSION ?= v0.19.0
KIND_CLUSTER_NAME ?= frr-k8s
HELM_VERSION ?= v3.12.3
HELM_DOCS_VERSION ?= v1.10.0

.PHONY: install
install: kubectl manifests kustomize ## Install CRDs into the K8s cluster specified in $KUBECONFIG_PATH.
Expand Down Expand Up @@ -258,3 +259,7 @@ generate-all-in-one: manifests kustomize ## Create manifests

$(KUSTOMIZE) build config/default > config/all-in-one/frr-k8s.yaml
$(KUSTOMIZE) build config/prometheus > config/all-in-one/frr-k8s-prometheus.yaml

.PHONY: helm-docs
helm-docs:
docker run --rm -v $(git rev-parse --show-toplevel):/app -w /app jnorwood/helm-docs:$(HELM_DOCS_VERSION) helm-docs

0 comments on commit a512ef9

Please sign in to comment.