docs: remove misleading publishConnectionDetailsTo references (#266)

[markussiebert]

What this does

Fixes #266 by removing the misleading publishConnectionDetailsTo references.

publishConnectionDetailsTo is a Crossplane v1 feature (backed by the alpha External Secret Stores mechanism). It does not exist in the Crossplane v2 managed-resource spec this provider uses — neither ManagedResourceSpec (namespaced) nor ClusterManagedResourceSpec expose it; both only have writeConnectionSecretToRef. Setting publishConnectionDetailsTo is therefore silently pruned by the API server (no error, no effect), which is what the issue observed.

Since the field cannot be supported on Crossplane v2, this takes the "delete the misleading comments" path from the issue's Definition of Done.

Changes

• Removed the ... or publishConnectionDetailsTo wording from:
  • the Runner Kind doc comments (project/group/instance) → also updates the generated CRD descriptions
  • the License Kind doc comment
  • the errMissingConnectionSecret message in the three runner controllers
• Regenerated the cluster (zz_) mirrors and CRDs. No schema changes (description text only).

Testing

go build ./..., full go test ./..., and golangci-lint all pass.

[Copilot]

Pull request overview

This PR addresses issue #266 by removing misleading references to publishConnectionDetailsTo (a Crossplane v1 feature) from this provider’s docs and user-facing error messages, aligning the repository with Crossplane v2 managed-resource behavior (i.e., only writeConnectionSecretToRef applies).

Changes:

• Updated runner controller validation error messages to require writeConnectionSecretToRef (removing “or publishConnectionDetailsTo”).
• Updated Runner and License API type doc comments to remove publishConnectionDetailsTo references and regenerated cluster (zz_) mirrors.
• Regenerated CRD description text to reflect the corrected guidance (description-only changes).

Reviewed changes

Copilot reviewed 15 out of 22 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
pkg/namespaced/controller/projects/runners/controller.go	Updates missing-connection-secret error message to reference only writeConnectionSecretToRef.
pkg/namespaced/controller/instance/runners/controller.go	Updates missing-connection-secret error message to reference only writeConnectionSecretToRef.
pkg/namespaced/controller/groups/runners/controller.go	Updates missing-connection-secret error message to reference only writeConnectionSecretToRef.
pkg/cluster/controller/projects/runners/zz_controller.go	Regenerated mirror: updates missing-connection-secret error message to reference only writeConnectionSecretToRef.
pkg/cluster/controller/instance/runners/zz_controller.go	Regenerated mirror: updates missing-connection-secret error message to reference only writeConnectionSecretToRef.
pkg/cluster/controller/groups/runners/zz_controller.go	Regenerated mirror: updates missing-connection-secret error message to reference only writeConnectionSecretToRef.
package/crds/projects.gitlab.m.crossplane.io_runners.yaml	CRD description text updated to remove publishConnectionDetailsTo guidance.
package/crds/projects.gitlab.crossplane.io_runners.yaml	CRD description text updated to remove publishConnectionDetailsTo guidance.
package/crds/instance.gitlab.m.crossplane.io_runners.yaml	CRD description text updated to remove publishConnectionDetailsTo guidance.
package/crds/instance.gitlab.m.crossplane.io_licenses.yaml	CRD description text updated to remove publishConnectionDetailsTo guidance.
package/crds/instance.gitlab.crossplane.io_runners.yaml	CRD description text updated to remove publishConnectionDetailsTo guidance.
package/crds/instance.gitlab.crossplane.io_licenses.yaml	CRD description text updated to remove publishConnectionDetailsTo guidance.
package/crds/groups.gitlab.m.crossplane.io_runners.yaml	CRD description text updated to remove publishConnectionDetailsTo guidance.
package/crds/groups.gitlab.crossplane.io_runners.yaml	CRD description text updated to remove publishConnectionDetailsTo guidance.
apis/namespaced/projects/v1alpha1/runner_types.go	Runner doc comment updated to remove publishConnectionDetailsTo reference.
apis/namespaced/instance/v1alpha1/runner_types.go	Runner doc comment updated to remove publishConnectionDetailsTo reference.
apis/namespaced/instance/v1alpha1/license_types.go	License doc comment updated to remove publishConnectionDetailsTo reference.
apis/namespaced/groups/v1alpha1/runner_types.go	Runner doc comment updated to remove publishConnectionDetailsTo reference.
apis/cluster/projects/v1alpha1/zz_runner_types.go	Regenerated mirror: Runner doc comment updated to remove publishConnectionDetailsTo reference.
apis/cluster/instance/v1alpha1/zz_runner_types.go	Regenerated mirror: Runner doc comment updated to remove publishConnectionDetailsTo reference.
apis/cluster/instance/v1alpha1/zz_license_types.go	Regenerated mirror: License doc comment updated to remove publishConnectionDetailsTo reference.
apis/cluster/groups/v1alpha1/zz_runner_types.go	Regenerated mirror: Runner doc comment updated to remove publishConnectionDetailsTo reference.

Files not reviewed (7)

• apis/cluster/groups/v1alpha1/zz_runner_types.go: Generated file
• apis/cluster/instance/v1alpha1/zz_license_types.go: Generated file
• apis/cluster/instance/v1alpha1/zz_runner_types.go: Generated file
• apis/cluster/projects/v1alpha1/zz_runner_types.go: Generated file
• pkg/cluster/controller/groups/runners/zz_controller.go: Generated file
• pkg/cluster/controller/instance/runners/zz_controller.go: Generated file
• pkg/cluster/controller/projects/runners/zz_controller.go: Generated file

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.