Skip to content

Commit

Permalink
Added spec params description (#1245)
Browse files Browse the repository at this point in the history
* fix

* fixed docker

* updated docs
  • Loading branch information
AndrewChubatiuk authored Sep 4, 2024
1 parent 566e979 commit 73078bf
Show file tree
Hide file tree
Showing 36 changed files with 14,177 additions and 1,810 deletions.
19 changes: 10 additions & 9 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
URL=https://victoriametrics.github.io/helm-charts/
HELM_IMAGE = alpine/helm:3.15.3
HELM_DOCS_IMAGE = jnorwood/helm-docs:v1.14.2
HELM_DOCS_IMAGE = jnorwood/helm-docs:v1.15-fork
CT_IMAGE = quay.io/helmpack/chart-testing:v3.11.0
KNOWN_TARGETS=helm
HELM?=helm-docker
CT?=ct-docker
CONTAINER ?= docker
Expand All @@ -25,8 +23,8 @@ helm-docker:
mkdir -p .helm/cache
$(CONTAINER) run --rm --name helm-exec \
$(CONTAINER_USER_OPTION) \
--volume "$(shell pwd):/helm-charts$(CONTAINER_VOLUME_OPTION_SUFFIX)" \
--volume "$(shell pwd)/.github/ci/helm-repos.yaml:/helm-charts/.helm/config/repositories.yaml$(CONTAINER_VOLUME_OPTION_SUFFIX)" \
--volume "$(PWD):/helm-charts$(CONTAINER_VOLUME_OPTION_SUFFIX)" \
--volume "$(PWD)/.github/ci/helm-repos.yaml:/helm-charts/.helm/config/repositories.yaml$(CONTAINER_VOLUME_OPTION_SUFFIX)" \
-w /helm-charts \
-e HELM_CACHE_HOME=/helm-charts/.helm/cache \
-e HELM_CONFIG_HOME=/helm-charts/.helm/config \
Expand All @@ -42,8 +40,8 @@ ct-docker:
mkdir -p .helm/cache
$(CONTAINER) run --rm --name helm-exec \
$(CONTAINER_USER_OPTION) \
--volume "$(shell pwd):/helm-charts$(CONTAINER_VOLUME_OPTION_SUFFIX)" \
--volume "$(shell pwd)/.github/ci/helm-repos.yaml:/helm-charts/.helm/config/repositories.yaml$(CONTAINER_VOLUME_OPTION_SUFFIX)" \
--volume "$(PWD):/helm-charts$(CONTAINER_VOLUME_OPTION_SUFFIX)" \
--volume "$(PWD)/.github/ci/helm-repos.yaml:/helm-charts/.helm/config/repositories.yaml$(CONTAINER_VOLUME_OPTION_SUFFIX)" \
-w /helm-charts \
-e HELM_CACHE_HOME=/helm-charts/.helm/cache \
-e HELM_CONFIG_HOME=/helm-charts/.helm/config \
Expand Down Expand Up @@ -99,9 +97,12 @@ init:
CMD="repo update" $(MAKE) $(HELM)

gen-docs:
$(CONTAINER) build $(PWD)/hack/docs \
-t $(HELM_DOCS_IMAGE) && \
$(CONTAINER) run --rm \
$(CONTAINER_USER_OPTION) \
--volume "$(shell pwd):/helm-charts$(CONTAINER_VOLUME_OPTION_SUFFIX)" \
--volume "$(PWD):/helm-charts$(CONTAINER_VOLUME_OPTION_SUFFIX)" \
-w /helm-charts \
--entrypoint /bin/helm-docs \
$(HELM_DOCS_IMAGE) \
helm-docs
-t hack/docs/template.tmpl -t README.md.gotmpl
Loading

0 comments on commit 73078bf

Please sign in to comment.