fix: avoid reporting errors for non-Tekton res

The handling of YAML validation errors was refactored to be more
intelligent and less noisy. It now only reports errors for resources
that are identified as Tekton resources or are fundamentally invalid YAML.

- Refactored validation errors from a simple map to a structured type
  that includes the resource name, schema, and error object.
- Updated YAML parsing to extract the resource's `apiVersion` (schema)
  even when the document fails to decode fully as a Tekton object.
- Implemented filtering to report validation errors only for resources
  with a `tekton.dev` API group or for generic YAML syntax errors.
- This prevents creating error comments on pull requests for other
  valid, non-Tekton YAML files located in the `.tekton` directory.

Jira: https://issues.redhat.com/browse/SRVKP-7906

Signed-off-by: Chmouel Boudjnah <[email protected]>

Author: chmouel

docs/content/docs/guide/running.md

@@ -124,9 +124,8 @@ click on it and follow the pipeline execution directly there.
 
 ## Errors When Parsing PipelineRun YAML
 
-When Pipelines-As-Code encounters an issue with the YAML formatting in the
-repository, it will create comment on pull request describing the error and will log the error in the user namespace events log and
-the Pipelines-as-Code controller log.
+If Pipelines-As-Code encounters an issue with the YAML formatting of Tekton resources in the repository, it will create a comment on
+the pull request describing the error. The error will also be logged in the user namespace events log and in the Pipelines-as-Code controller log.
 
 Despite validation errors, Pipelines-as-Code continues to run other correctly parsed and matched PipelineRuns.
 However, if a PipelineRun has YAML syntax error, it halts the execution of all PipelineRuns, even those that are syntactically correct.

pkg/errors/errors.go

@@ -0,0 +1,9 @@
+package errors
+
+type PacYamlValidations struct {
+	Name   string
+	Err    error
+	Schema string
+}
+
+const GenericBadYAMLValidation = "Generic bad YAML Validation"

pkg/pipelineascode/match.go

@@ -9,6 +9,7 @@ import (
 
 	apipac "github.com/openshift-pipelines/pipelines-as-code/pkg/apis/pipelinesascode/keys"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/apis/pipelinesascode/v1alpha1"
+	pacerrors "github.com/openshift-pipelines/pipelines-as-code/pkg/errors"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/matcher"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/opscomments"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/params/triggertype"
@@ -186,7 +187,15 @@ func (p *PacRun) getPipelineRunsFromRepo(ctx context.Context, repo *v1alpha1.Rep
 		reg := regexp.MustCompile(`error unmarshalling yaml file\s([^:]*):\s*(yaml:\s*)?(.*)`)
 		matches := reg.FindStringSubmatch(err.Error())
 		if len(matches) == 4 {
-			p.reportValidationErrors(ctx, repo, map[string]string{matches[1]: matches[3]})
+			p.reportValidationErrors(ctx, repo,
+				[]*pacerrors.PacYamlValidations{
+					{
+						Name:   matches[1],
+						Err:    fmt.Errorf("yaml validation error: %s", matches[3]),
+						Schema: pacerrors.GenericBadYAMLValidation,
+					},
+				},
+			)
 			return nil, nil
 		}
 
@@ -463,12 +472,19 @@ func (p *PacRun) createNeutralStatus(ctx context.Context) error {
 // 1. Creating error messages for each validation error
 // 2. Emitting error messages to the event system
 // 3. Creating a markdown formatted comment on the repository with all errors.
-func (p *PacRun) reportValidationErrors(ctx context.Context, repo *v1alpha1.Repository, validationErrors map[string]string) {
+func (p *PacRun) reportValidationErrors(ctx context.Context, repo *v1alpha1.Repository, validationErrors []*pacerrors.PacYamlValidations) {
 	errorRows := make([]string, 0, len(validationErrors))
-	for name, err := range validationErrors {
-		errorRows = append(errorRows, fmt.Sprintf("| %s | `%s` |", name, err))
+	for _, err := range validationErrors {
+		// if the error is a TektonConversionError, we don't want to report it since it may be a file that is not a tekton resource
+		// and we don't want to report it as a validation error.
+		if strings.HasPrefix(err.Schema, tektonv1.SchemeGroupVersion.Group) || err.Schema == pacerrors.GenericBadYAMLValidation {
+			errorRows = append(errorRows, fmt.Sprintf("| %s | `%s` |", err.Name, err.Err.Error()))
+		}
 		p.eventEmitter.EmitMessage(repo, zap.ErrorLevel, "PipelineRunValidationErrors",
-			fmt.Sprintf("cannot read the PipelineRun: %s, error: %s", name, err))
+			fmt.Sprintf("cannot read the PipelineRun: %s, error: %s", err.Name, err.Err.Error()))
+	}
+	if len(errorRows) == 0 {
+		return
 	}
 	markdownErrMessage := fmt.Sprintf(`%s
 %s`, validationErrorTemplate, strings.Join(errorRows, "\n"))

pkg/resolve/resolve.go

@@ -4,9 +4,11 @@ import (
 	"context"
 	"fmt"
 	"regexp"
+	"slices"
 	"strings"
 
 	apipac "github.com/openshift-pipelines/pipelines-as-code/pkg/apis/pipelinesascode/keys"
+	pacerrors "github.com/openshift-pipelines/pipelines-as-code/pkg/errors"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/formatting"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/matcher"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/params"
@@ -15,7 +17,6 @@ import (
 	tektonv1 "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1"
 	tektonv1beta1 "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
 	"go.uber.org/zap"
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	k8scheme "k8s.io/client-go/kubernetes/scheme"
 	yaml "sigs.k8s.io/yaml/goyaml.v2"
 )
@@ -26,7 +27,7 @@ type TektonTypes struct {
 	Pipelines        []*tektonv1.Pipeline
 	TaskRuns         []*tektonv1.TaskRun
 	Tasks            []*tektonv1.Task
-	ValidationErrors map[string]string
+	ValidationErrors []*pacerrors.PacYamlValidations
 }
 
 // Contains Fetched Resources for Event, with key equals to annotation value.
@@ -43,31 +44,34 @@ type FetchedResourcesForRun struct {
 
 func NewTektonTypes() TektonTypes {
 	return TektonTypes{
-		ValidationErrors: map[string]string{},
+		ValidationErrors: []*pacerrors.PacYamlValidations{},
 	}
 }
 
 var yamlDocSeparatorRe = regexp.MustCompile(`(?m)^---\s*$`)
 
-// detectAtleastNameOrGenerateNameFromPipelineRun detects the name or
+// detectAtleastNameOrGenerateNameAndSchemaFromPipelineRun detects the name or
 // generateName of a yaml files even if there is an error decoding it as tekton types.
-func detectAtleastNameOrGenerateNameFromPipelineRun(data string) string {
-	var metadataName struct {
-		Metadata metav1.ObjectMeta
+func detectAtleastNameOrGenerateNameAndSchemaFromPipelineRun(data string) (string, string) {
+	var genericKubeObj struct {
+		APIVersion string `yaml:"apiVersion"`
+		Metadata   struct {
+			Name         string `yaml:"name,omitempty"`
+			GenerateName string `yaml:"generateName,omitempty"`
+		} `yaml:"metadata"`
 	}
-	err := yaml.Unmarshal([]byte(data), &metadataName)
+	err := yaml.Unmarshal([]byte(data), &genericKubeObj)
 	if err != nil {
-		return ""
+		return "nokube", ""
 	}
-	if metadataName.Metadata.Name != "" {
-		return metadataName.Metadata.Name
+	if genericKubeObj.Metadata.Name != "" {
+		return genericKubeObj.Metadata.Name, genericKubeObj.APIVersion
 	}
 
-	// TODO: yaml Unmarshal don't want to parse generatename and i have no idea why
-	if metadataName.Metadata.GenerateName != "" {
-		return metadataName.Metadata.GenerateName
+	if genericKubeObj.Metadata.GenerateName != "" {
+		return genericKubeObj.Metadata.GenerateName, genericKubeObj.APIVersion
 	}
-	return "unknown"
+	return "unknown", genericKubeObj.APIVersion
 }
 
 // getPipelineByName returns the Pipeline with the given name the first one found
@@ -106,15 +110,6 @@ func pipelineRunsWithSameName(prs []*tektonv1.PipelineRun) error {
 	return nil
 }
 
-func skippingTask(taskName string, skippedTasks []string) bool {
-	for _, value := range skippedTasks {
-		if value == taskName {
-			return true
-		}
-	}
-	return false
-}
-
 func isTektonAPIVersion(apiVersion string) bool {
 	return strings.HasPrefix(apiVersion, "tekton.dev/") || apiVersion == ""
 }
@@ -126,7 +121,7 @@ func inlineTasks(tasks []tektonv1.PipelineTask, ropt *Opts, remoteResource Fetch
 			task.TaskRef.Resolver == "" &&
 			isTektonAPIVersion(task.TaskRef.APIVersion) &&
 			string(task.TaskRef.Kind) != "ClusterTask" &&
-			!skippingTask(task.TaskRef.Name, ropt.SkipInlining) {
+			!slices.Contains(ropt.SkipInlining, task.TaskRef.Name) {
 			taskResolved, ok := remoteResource.Tasks[task.TaskRef.Name]
 			if !ok {
 				return nil, fmt.Errorf("cannot find referenced task %s. if it's a remote task make sure to add it in the annotations", task.TaskRef.Name)
@@ -164,7 +159,12 @@ func ReadTektonTypes(ctx context.Context, log *zap.SugaredLogger, data string) (
 
 		obj, _, err := decoder.Decode([]byte(doc), nil, nil)
 		if err != nil {
-			types.ValidationErrors[detectAtleastNameOrGenerateNameFromPipelineRun(doc)] = err.Error()
+			dt, dv := detectAtleastNameOrGenerateNameAndSchemaFromPipelineRun(doc)
+			types.ValidationErrors = append(types.ValidationErrors, &pacerrors.PacYamlValidations{
+				Name:   dt,
+				Err:    fmt.Errorf("error decoding yaml document: %w", err),
+				Schema: dv,
+			})
 			continue
 		}
 		switch o := obj.(type) {