markers helper can't detect markers which are separated with space.

[sivchari]

https://github.com/kubernetes-sigs/cluster-api/blob/main/api/v1beta2/cluster_types.go#L1285-L1296

// +kubebuilder:object:root=true

// ClusterList contains a list of Cluster.
type ClusterList struct {
	metav1.TypeMeta `json:",inline"`
	// metadata is the standard list's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#lists-and-simple-kinds
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`
	// items is the list of Clusters.
	Items []Cluster `json:"items"`
}

Above code must be reported by statussubresource linter since this custom resource has root marker and must also have status marker.
But currently marker accessor helper can't collect it because there is space between root marker and ClusterList type.

So I think we should discuss about 2 topic.

1. The way to be able to collect all markers in spite of space.
2. Configuration for statussubresource. (e.g. ignore error when the type has List suffix on itself.)

[JoelSpeed]

Ahh yeah, we do need to be able to collect second level comments, so that is definitely a valid bug!

And yes, I had intended to implement something to ignore XList types. We need a check, early on that determines if the field we are reviewing is:

• In a struct whose name ends List
• AND that struct has three fields
• AND those three fields are the embedded TypeMeta, ListMeta and an Items slice

If we determine that we are in a struct like that, we should skip all linting IMO

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[sivchari]

we should handle second level comment.

[sivchari]

/remove-lifecycle stale

[saschagrunert]

Approaching a fix in #177

[saschagrunert]

/assign

[sivchari]

Hmm, surely the statussubresource linting seemed to become more strict, but the second level comment bug is still valid.
So I reopen this issue.

/reopen