explain nolints

On-behalf-of: @SAP [email protected]

Author: xrstf

internal/projection/projection.go

@@ -116,7 +116,7 @@ func ProjectCRD(crd *apiextensionsv1.CustomResourceDefinition, pubRes *syncagent
 func stripUnwantedVersions(crd *apiextensionsv1.CustomResourceDefinition, pubRes *syncagentv1alpha1.PublishedResource) (*apiextensionsv1.CustomResourceDefinition, error) {
 	src := pubRes.Spec.Resource
 
-	//nolint:staticcheck
+	//nolint:staticcheck // .Version is deprecated, but we still support it for now.
 	if src.Version != "" && len(src.Versions) > 0 {
 		return nil, errors.New("cannot configure both .version and .versions in as the source of a PublishedResource")
 	}
@@ -181,7 +181,7 @@ func projectCRDVersions(crd *apiextensionsv1.CustomResourceDefinition, pubRes *s
 
 	// We already validated that Version and Versions can be set at the same time.
 
-	//nolint:staticcheck
+	//nolint:staticcheck // .Version is deprecated, but we still support it for now.
 	if projection.Version != "" {
 		if size := len(crd.Spec.Versions); size != 1 {
 			return nil, fmt.Errorf("cannot project CRD version to a single version %q because it contains %d versions", projection.Version, size)

internal/sync/syncer_related.go

@@ -251,7 +251,7 @@ func resolveRelatedResourceObjects(relatedOrigin, relatedDest syncSide, relRes s
 
 func resolveRelatedResourceOriginNamespaces(relatedOrigin, relatedDest syncSide, origin syncagentv1alpha1.RelatedResourceOrigin, spec syncagentv1alpha1.RelatedResourceObjectSpec) (map[string]string, error) {
 	switch {
-	//nolint:staticcheck
+	//nolint:staticcheck // .Reference is deprecated, but we still support it for now.
 	case spec.Reference != nil:
 		originNamespace, err := resolveObjectReference(relatedOrigin.object, *spec.Reference) //nolint:staticcheck
 		if err != nil {

internal/sync/templating/naming.go

@@ -92,7 +92,8 @@ func generateLocalObjectIdentifier(pattern string, object *unstructured.Unstruct
 		return Render(pattern, newLocalObjectNamingContext(object, clusterName, clusterPath))
 	}
 
-	// legacy $variable style, does also not support clusterPath
+	// Legacy $variable style, does also not support clusterPath;
+	// note that all of these constants are deprecated already.
 	replacer := strings.NewReplacer(
 		// order of elements is important here, "$fooHash" needs to be defined before "$foo"
 		syncagentv1alpha1.PlaceholderRemoteClusterName, clusterName.String(), //nolint:staticcheck