younsl opened a new pull request, #451: URL: https://github.com/apache/superset-kubernetes-operator/pull/451
## Summary Several statements in the contributor docs and AGENTS.md no longer match the code. A new contributor who follows them copies a test example that does not compile, looks for fields and types that do not exist, and reads that the project uses Dependabot when it uses Renovate. This PR updates each statement to match the current tree. It changes docs only. ## Details - Go version: AGENTS.md and the development setup table said 1.26+. go.mod requires 1.27.2, so both now say 1.27+. - Unit test example: record.NewFakeRecorder becomes events.NewFakeRecorder, since SupersetReconciler.Recorder is an events.EventRecorder. The example now points at reconcile_parent_resources_test.go, where the fake client TestReconcile tests live. superset_controller_test.go is the Ginkgo envtest suite. - Rat jar path: check_license.sh caches the jar under the XDG cache directory instead of /tmp/lib. - KIND_NODE_IMAGE: the Makefile reads it from .github/supported-k8s.json instead of pinning it. - Pure packages: internal/schedule is listed as a fourth pure Go package in the overview and the package tree. The logging section of the same page already listed it. - Merge guidance: Merge*ByName does not exist. The text now names the real helpers (MergeEnvVars, MergeVolumes and so on) and applies the (topLevel, component, operatorInjected) ordering rule to those collection helpers only, since MergeDeploymentTemplate, MergePodTemplate and MergeContainerTemplate take (comp, tl). - How to Add a New Component: hasConfig does not exist. componentReconcilerConfig has defaultPort and hasScaling, and componentDescriptor has hasPythonConfig. - Key files table: InitSpec does not exist, so the row now lists LifecycleSpec. - releasing.md: the SHA pinning note now says Renovate instead of Dependabot (there is no Dependabot config). The Renovate section no longer says weekly, since renovate.json has no weekly schedule. <details> <summary>Verification</summary> - Each change was checked against the file it describes: go.mod, internal/controller/superset_controller.go, internal/controller/reconcile_parent_resources_test.go, scripts/check_license.sh, Makefile, internal/schedule, internal/resolution/merge.go, internal/controller/component_reconciler.go, internal/controller/component_descriptors.go, api/v1alpha1/superset_types.go and renovate.json. - make lint-md passes. - mkdocs build in strict mode passes with the pinned docs requirements. </details> -- 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]
