villebro opened a new pull request, #79: URL: https://github.com/apache/superset-kubernetes-operator/pull/79
## Summary The list of `make` targets in `README.md` and `docs/contributing/development-setup.md` was hand-curated and had drifted from the Makefile. This PR replaces both with sentinel-bounded blocks generated from the Makefile's existing `##@ Section` headers and `target: ## description` annotations, wired into `make codegen` so CI's existing `Verify codegen` job catches future drift. - New `scripts/render-make-commands.sh` parses the Makefile and rewrites sentinel-bounded blocks in `README.md` and `docs/contributing/development-setup.md`. Skips the `General` and `Dependencies` sections (help + tool-bootstrap targets). - New `make make-commands` target, chained into `make codegen`. - Fixed broken link in `CONTRIBUTING.md` (`docs/developer-guide.md` → `docs/contributing/development-setup.md` + `development-guidelines.md`). ## Drift bugs fixed - `make docker-buildx` was documented in `development-setup.md` but does not exist in the Makefile — gone now (generator only renders real targets). - `lint-fix`, `lint-config`, `setup-test-e2e`, `cleanup-test-e2e`, `build-installer`, `helm-sync-crds`, `fmt`, `vet`, `supported-versions`, `sync-supported-versions`, `verify-supported-versions` were missing from the docs — now appear. - `CONTRIBUTING.md` linked to a non-existent `docs/developer-guide.md`. ## Details Follows the project's automation principle (see `CLAUDE.md`): every "remember to also update X when Y changes" instruction is a bug in the tooling. The Makefile already had `## help text` annotations on every target — this PR just stops duplicating that source of truth into hand-edited Markdown. Mirrors the existing `<!-- BEGIN SUPPORTED-K8S -->` pattern and `scripts/render-supported-versions.sh`. To surface a new target in the docs, place it under a `##@ <Section>` other than `General`/`Dependencies` and give it a `## description` annotation. `make codegen` does the rest. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
