WIP: add version to workflow configs

pipeline/frontend/yaml/error.go

@@ -16,6 +16,10 @@ package yaml
 
 import "errors"
 
+var (
+	ErrUnsuportedVersion = errors.New("unsuported yaml version detected")
+)
+
 // PipelineParseError is an error that occurs when the pipeline parsing fails.
 type PipelineParseError struct {
 	Err error

pipeline/frontend/yaml/parse.go

@@ -4,27 +4,37 @@ import (
 	"fmt"
 
 	"codeberg.org/6543/xyaml"
+	"gopkg.in/yaml.v3"
 
+	"github.com/woodpecker-ci/woodpecker/pipeline/frontend/yaml"
 	"github.com/woodpecker-ci/woodpecker/pipeline/frontend/yaml/constraint"
 	"github.com/woodpecker-ci/woodpecker/pipeline/frontend/yaml/types"
 )
 
 // ParseBytes parses the configuration from bytes b.
 func ParseBytes(b []byte) (*types.Workflow, error) {
+	yamlVersion, err := checkVersion(b)
+	if err != nil {
+		&PipelineParseError{Err: err}
+	}
+
 	out := new(types.Workflow)
 	err := xyaml.Unmarshal(b, out)
 	if err != nil {
-		return nil, err
+		return nil, &PipelineParseError{Err: err}
 	}
 
+	// make sure detected version is set
+	out.Version = yamlVersion
+
 	// support deprecated branch filter
 	if out.BranchesDontUseIt != nil {
 		if out.When.Constraints == nil {
 			out.When.Constraints = []constraint.Constraint{{Branch: *out.BranchesDontUseIt}}
 		} else if len(out.When.Constraints) == 1 && out.When.Constraints[0].Branch.IsEmpty() {
 			out.When.Constraints[0].Branch = *out.BranchesDontUseIt
 		} else {
-			return nil, fmt.Errorf("could not apply deprecated branches filter into global when filter")
+			return nil, &PipelineParseError{Err: fmt.Errorf("could not apply deprecated branches filter into global when filter")}
 		}
 		out.BranchesDontUseIt = nil
 	}
@@ -38,3 +48,19 @@ func ParseString(s string) (*types.Workflow, error) {
 		[]byte(s),
 	)
 }
+
+func checkVersion(b []byte) (string, error) {
+	verStr := struct {
+		Version string `yaml:"version"`
+	}{}
+	_ = yaml.Unmarshal(b, &verStr)
+	// TODO: should we require a version number -> in therms of UX we should not, in terms of strong typisation we should
+	if verStr == "" {
+		verStr = Version
+	}
+
+	if verStr != Version {
+		return "", ErrUnsuportedVersion
+	}
+	return verStr, nil
+}

pipeline/frontend/yaml/types/workflow.go

@@ -18,6 +18,7 @@ type (
 		DependsOn []string        `yaml:"depends_on,omitempty"`
 		RunsOn    []string        `yaml:"runs_on,omitempty"`
 		SkipClone bool            `yaml:"skip_clone"`
+		Version   string          `yaml:"version"`
 		// Undocumented
 		Cache    base.StringOrSlice `yaml:"cache,omitempty"`
 		Networks WorkflowNetworks   `yaml:"networks,omitempty"`

pipeline/frontend/yaml/version.go

@@ -0,0 +1,18 @@
+// Copyright 2022 Woodpecker Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package yaml
+
+// Version of this package and it's subpackages
+const Version = "1"