mirror of
https://github.com/hanzoai/ingress.git
synced 2026-10-26 02:47:15 +00:00
zeekayandHanzo Dev
15d100931d
Hanzo CI/CD / cicd (push) Failing after 9m46s
CI/CD / cicd (push) Failing after 10m4s
Most of it was stale, not cosmetic: the docs taught `TRAEFIK_*` env, `traefik.http.*` labels, `traefik.ingress.kubernetes.io/` annotations, `.traefik.yml` plugins and `traefik_*` metrics. This binary answers to `INGRESS_*`, `ingress.http.*`, `ingress.kubernetes.io/`, `.ingress.yml` and `ingress.*` — a reader following the old text configured nothing. Two were worse than stale. Gateway API examples gave `group: traefik.io` for an IngressService backendRef, which kubernetes.go:1265 refuses against hanzo.ai. The contributing guide built with `github.com/traefik/ingress` ldflags against a module that is `github.com/hanzoai/ingress/v3`. script/code-gen.sh globs `hanzo.ai_*.yaml` and matched nothing — the per-CRD dumps had been deleted and never regenerated, so `cat` failed the script under `set -e`. controller-gen v0.19.0 restores all ten; they concatenate byte-for-byte into the committed definition and fixture. CHANGELOG.md is untouched: 6,789 lines of imported release history, where a rewrite would falsify the record rather than rebrand it. `@traefiklabs/faency`, `traefik/whoami`, k3s's `--disable=traefik`, the `traefik.io` CRD group and the MIT attribution stay — upstream's addresses, not our brand. Co-authored-by: Hanzo Dev <[email protected]>
66 lines
1.8 KiB
Makefile
66 lines
1.8 KiB
Makefile
#######
|
|
# This Makefile contains all targets related to the documentation
|
|
#######
|
|
|
|
DOCS_VERIFY_SKIP ?= false
|
|
DOCS_LINT_SKIP ?= false
|
|
|
|
INGRESS_DOCS_BUILD_IMAGE ?= ingress-docs
|
|
INGRESS_DOCS_CHECK_IMAGE ?= $(INGRESS_DOCS_BUILD_IMAGE)-check
|
|
|
|
SITE_DIR := $(CURDIR)/site
|
|
|
|
DOCKER_RUN_DOC_PORT := 8000
|
|
DOCKER_RUN_DOC_MOUNTS := -v $(CURDIR):/mkdocs
|
|
DOCKER_RUN_DOC_OPTS := --rm $(DOCKER_RUN_DOC_MOUNTS) -p $(DOCKER_RUN_DOC_PORT):8000
|
|
|
|
# Default: generates the documentation into $(SITE_DIR)
|
|
.PHONY: docs
|
|
docs: docs-clean docs-image docs-lint docs-build docs-verify
|
|
|
|
# Writer Mode: build and serve docs on http://localhost:8000 with livereload
|
|
.PHONY: docs-serve
|
|
docs-serve: docs-image
|
|
docker run $(DOCKER_RUN_DOC_OPTS) $(INGRESS_DOCS_BUILD_IMAGE) mkdocs serve -a 0.0.0.0:8000
|
|
|
|
## Pull image for doc building
|
|
.PHONY: docs-pull-images
|
|
docs-pull-images:
|
|
grep --no-filename -E '^FROM' ./*.Dockerfile \
|
|
| awk '{print $$2}' \
|
|
| sort \
|
|
| uniq \
|
|
| xargs -P 6 -n 1 docker pull
|
|
|
|
# Utilities Targets for each step
|
|
.PHONY: docs-image
|
|
docs-image:
|
|
docker build -t $(INGRESS_DOCS_BUILD_IMAGE) -f docs.Dockerfile ./
|
|
|
|
.PHONY: docs-build
|
|
docs-build: docs-image
|
|
docker run $(DOCKER_RUN_DOC_OPTS) $(INGRESS_DOCS_BUILD_IMAGE) sh -c "mkdocs build \
|
|
&& chown -R $(shell id -u):$(shell id -g) ./site"
|
|
|
|
.PHONY: docs-verify
|
|
docs-verify: docs-build
|
|
ifneq ("$(DOCS_VERIFY_SKIP)", "true")
|
|
docker build -t $(INGRESS_DOCS_CHECK_IMAGE) -f check.Dockerfile ./
|
|
docker run --rm -v $(CURDIR):/app $(INGRESS_DOCS_CHECK_IMAGE) /verify.sh
|
|
else
|
|
echo "DOCS_VERIFY_SKIP is true: no verification done."
|
|
endif
|
|
|
|
.PHONY: docs-lint
|
|
docs-lint:
|
|
ifneq ("$(DOCS_LINT_SKIP)", "true")
|
|
docker build -t $(INGRESS_DOCS_CHECK_IMAGE) -f check.Dockerfile ./
|
|
docker run --rm -v $(CURDIR):/app $(INGRESS_DOCS_CHECK_IMAGE) /lint.sh
|
|
else
|
|
echo "DOCS_LINT_SKIP is true: no linting done."
|
|
endif
|
|
|
|
.PHONY: docs-clean
|
|
docs-clean:
|
|
rm -rf $(SITE_DIR)
|