Add workflow version (#2476)

Closes #1834

---------

Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: Anbraten <anton@ju60.de>
Co-authored-by: Lauris BH <lauris@nix.lv>

.woodpecker/binaries.yml

@@ -1,3 +1,5 @@
+version: 1
+
 depends_on:
   - test
   - web

.woodpecker/docker.yml

@@ -1,3 +1,5 @@
+version: 1
+
 when:
   - event: [pull_request, tag]
   - event: push

.woodpecker/docs.yml

@@ -1,3 +1,5 @@
+version: 1
+
 when:
   - event: tag
   - event: pull_request

.woodpecker/release-helper.yml

@@ -1,3 +1,5 @@
+version: 1
+
 steps:
   release-helper:
     image: woodpeckerci/plugin-ready-release-go:0.7.0

.woodpecker/securityscan.yml

@@ -1,3 +1,5 @@
+version: 1
+
 when:
   - event: [pull_request, cron]
   - event: push

.woodpecker/test.yml

@@ -1,3 +1,5 @@
+version: 1
+
 when:
   - event: [pull_request, tag]
   - event: push

.woodpecker/web.yml

@@ -1,3 +1,5 @@
+version: 1
+
 when:
   - event: [pull_request, tag]
   - event: push

contrib/woodpecker-test-repo/.woodpecker/demo.yml

@@ -1,3 +1,4 @@
+version: 1
 steps:
   demo:
     image: 'alpine'

contrib/woodpecker-test-repo/.woodpecker/test.yml

@@ -1,3 +1,4 @@
+version: 1
 steps:
   test_1:
     image: 'alpine'

pipeline/frontend/yaml/linter/linter_test.go

@@ -26,6 +26,7 @@ import (
 func TestLint(t *testing.T) {
 	testdatas := []struct{ Title, Data string }{{
 		Title: "map", Data: `
+version: 1
 steps:
   build:
     image: docker
@@ -45,6 +46,7 @@ services:
 `,
 	}, {
 		Title: "list", Data: `
+version: 1
 steps:
   - name: build
     image: docker
@@ -61,6 +63,7 @@ steps:
 `,
 	}, {
 		Title: "merge maps", Data: `
+version: 1
 variables:
   step_template: &base-step
     image: golang:1.19
@@ -155,7 +158,7 @@ func TestLintErrors(t *testing.T) {
 	}
 
 	for _, test := range testdata {
-		conf, err := yaml.ParseString(test.from)
+		conf, err := yaml.ParseString("version: 1\n" + test.from)
 		if err != nil {
 			t.Fatalf("Cannot unmarshal yaml %q. Error: %s", test.from, err)
 		}

pipeline/frontend/yaml/linter/schema/.woodpecker/test-branches-array.yml

@@ -1,3 +1,5 @@
+version: 1
+
 branches: [main, pages]
 
 steps:

pipeline/frontend/yaml/linter/schema/.woodpecker/test-branches-exclude-include.yml

@@ -1,3 +1,5 @@
+version: 1
+
 branches:
   include: main
   exclude: [develop, feature/*]

pipeline/frontend/yaml/linter/schema/.woodpecker/test-branches.yml

@@ -1,3 +1,5 @@
+version: 1
+
 branches: main
 
 steps:

pipeline/frontend/yaml/linter/schema/.woodpecker/test-broken.yml

@@ -1,3 +1,5 @@
+version: 1
+
 branches: main
 
 matri:

pipeline/frontend/yaml/linter/schema/.woodpecker/test-clone-skip.yml

@@ -1,3 +1,5 @@
+version: 1
+
 steps:
   test:
     image: alpine

pipeline/frontend/yaml/linter/schema/.woodpecker/test-clone.yml

@@ -1,3 +1,5 @@
+version: 1
+
 clone:
   git:
     image: plugins/git:next

pipeline/frontend/yaml/linter/schema/.woodpecker/test-labels.yml

@@ -1,3 +1,5 @@
+version: 1
+
 labels:
   location: europe
   weather: sun

pipeline/frontend/yaml/linter/schema/.woodpecker/test-matrix.yml

@@ -1,3 +1,5 @@
+version: 1
+
 steps:
   test:
     image: golang:${GO_VERSION}

pipeline/frontend/yaml/linter/schema/.woodpecker/test-merge-map-and-sequence.yml

@@ -1,3 +1,5 @@
+version: 1
+
 variables:
   step_template: &base-step
     image: golang:1.19

pipeline/frontend/yaml/linter/schema/.woodpecker/test-multi.yml

@@ -1,3 +1,5 @@
+version: 1
+
 steps:
   deploy:
     image: golang

pipeline/frontend/yaml/linter/schema/.woodpecker/test-pipeline-when.yml

@@ -1,3 +1,5 @@
+version: 1
+
 when:
   - branch: [main, deploy]
     event: push

pipeline/frontend/yaml/linter/schema/.woodpecker/test-platform.yml

@@ -1,3 +1,5 @@
+version: 1
+
 platform: linux/amd64
 
 steps:

pipeline/frontend/yaml/linter/schema/.woodpecker/test-plugin.yml

@@ -1,3 +1,5 @@
+version: 1
+
 steps:
   build:
     image: golang

pipeline/frontend/yaml/linter/schema/.woodpecker/test-run-on.yml

@@ -1,3 +1,5 @@
+version: 1
+
 steps:
   build:
     image: golang

pipeline/frontend/yaml/linter/schema/.woodpecker/test-service.yml

@@ -1,3 +1,5 @@
+version: 1
+
 steps:
   build:
     image: golang

pipeline/frontend/yaml/linter/schema/.woodpecker/test-step.yml

@@ -1,3 +1,5 @@
+version: 1
+
 steps:
   image:
     image: golang

pipeline/frontend/yaml/linter/schema/.woodpecker/test-when.yml

@@ -1,3 +1,5 @@
+version: 1
+
 steps:
   when-branch:
     image: alpine

pipeline/frontend/yaml/linter/schema/.woodpecker/test-workspace.yml

@@ -1,3 +1,5 @@
+version: 1
+
 workspace:
   base: /go
   path: src/github.com/octocat/hello-world

pipeline/frontend/yaml/linter/schema/schema.json

@@ -34,7 +34,8 @@
       "type": "array",
       "minLength": 1,
       "items": { "type": "string" }
-    }
+    },
+    "version": { "type": "number", "default": 1 }
   },
   "definitions": {
     "clone": {

pipeline/frontend/yaml/parse.go

@@ -15,6 +15,7 @@
 package yaml
 
 import (
+	"errors"
 	"fmt"
 
 	"codeberg.org/6543/xyaml"
@@ -22,16 +23,27 @@ import (
 	"github.com/woodpecker-ci/woodpecker/pipeline/frontend/yaml/constraint"
 	"github.com/woodpecker-ci/woodpecker/pipeline/frontend/yaml/types"
 	"github.com/woodpecker-ci/woodpecker/pipeline/frontend/yaml/types/base"
+	"github.com/woodpecker-ci/woodpecker/shared/constant"
 )
 
+var ErrUnsuportedVersion = errors.New("unsuported pipeline config version detected")
+
 // ParseBytes parses the configuration from bytes b.
 func ParseBytes(b []byte) (*types.Workflow, error) {
-	out := new(types.Workflow)
+	yamlVersion, err := checkVersion(b)
-	err := xyaml.Unmarshal(b, out)
 	if err != nil {
 		return nil, err
 	}
 
+	out := new(types.Workflow)
+	err = xyaml.Unmarshal(b, out)
+	if err != nil {
+		return nil, err
+	}
+
+	// make sure detected version is set
+	out.Version = yamlVersion
+
 	// support deprecated branch filter
 	if out.BranchesDontUseIt != nil {
 		if out.When.Constraints == nil {
@@ -70,3 +82,19 @@ func ParseString(s string) (*types.Workflow, error) {
 		[]byte(s),
 	)
 }
+
+func checkVersion(b []byte) (int, error) {
+	ver := struct {
+		Version int `yaml:"version"`
+	}{}
+	_ = xyaml.Unmarshal(b, &ver)
+	if ver.Version == 0 {
+		// default: version 1
+		return constant.DefaultPipelineVersion, nil
+	}
+
+	if ver.Version != Version {
+		return 0, ErrUnsuportedVersion
+	}
+	return ver.Version, nil
+}

pipeline/frontend/yaml/parse_test.go

@@ -88,6 +88,16 @@ func TestParse(t *testing.T) {
 				g.Assert(out.Steps.ContainerList[1].When.Constraints[0].Event.Include).Equal([]string{"success"})
 			})
 
+			g.It("Should unmarshal with default version", func() {
+				out, err := ParseString(sampleYamlDefaultVersion)
+				if err != nil {
+					g.Fail(err)
+				}
+				g.Assert(len(out.Steps.ContainerList)).Equal(1)
+				g.Assert(out.Steps.ContainerList[0].Name).Equal("notify_success")
+				g.Assert(out.Steps.ContainerList[0].Image).Equal("xyz")
+			})
+
 			matchConfig, err := ParseString(sampleYaml)
 			if err != nil {
 				g.Fail(err)
@@ -180,6 +190,7 @@ pipeline:
 }
 
 var sampleYaml = `
+version: 1
 image: hello-world
 when:
   - event:
@@ -231,7 +242,14 @@ runs_on:
   - failure
 `
 
+var sampleYamlDefaultVersion = `
+steps:
+  - name: notify_success
+    image: xyz
+`
+
 var simpleYamlAnchors = `
+version: 1
 vars:
   image: &image plugins/slack
 steps:
@@ -240,6 +258,7 @@ steps:
 `
 
 var sampleVarYaml = `
+version: 1
 _slack: &SLACK
   image: plugins/slack
 steps:

pipeline/frontend/yaml/types/workflow.go

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

pipeline/frontend/yaml/version.go

@@ -0,0 +1,18 @@
+// Copyright 2023 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

pipeline/stepBuilder_test.go

@@ -47,6 +47,7 @@ func TestGlobalEnvsubst(t *testing.T) {
 		Link:  "",
 		Yamls: []*forge_types.FileMeta{
 			{Data: []byte(`
+version: 1
 steps:
   build:
     image: ${IMAGE}
@@ -83,6 +84,7 @@ func TestMissingGlobalEnvsubst(t *testing.T) {
 		Link:  "",
 		Yamls: []*forge_types.FileMeta{
 			{Data: []byte(`
+version: 1
 steps:
   build:
     image: ${IMAGE}
@@ -116,6 +118,7 @@ bbb`,
 		Link:  "",
 		Yamls: []*forge_types.FileMeta{
 			{Data: []byte(`
+version: 1
 steps:
   xxx:
     image: scratch
@@ -123,6 +126,7 @@ steps:
       yyy: ${CI_COMMIT_MESSAGE}
 `)},
 			{Data: []byte(`
+version: 1
 steps:
   build:
     image: scratch
@@ -153,11 +157,13 @@ func TestMultiPipeline(t *testing.T) {
 		Link:  "",
 		Yamls: []*forge_types.FileMeta{
 			{Data: []byte(`
+version: 1
 steps:
   xxx:
     image: scratch
 `)},
 			{Data: []byte(`
+version: 1
 steps:
   build:
     image: scratch
@@ -188,16 +194,19 @@ func TestDependsOn(t *testing.T) {
 		Link:  "",
 		Yamls: []*forge_types.FileMeta{
 			{Name: "lint", Data: []byte(`
+version: 1
 steps:
   build:
     image: scratch
 `)},
 			{Name: "test", Data: []byte(`
+version: 1
 steps:
   build:
     image: scratch
 `)},
 			{Data: []byte(`
+version: 1
 steps:
   deploy:
     image: scratch
@@ -235,6 +244,7 @@ func TestRunsOn(t *testing.T) {
 		Link:  "",
 		Yamls: []*forge_types.FileMeta{
 			{Data: []byte(`
+version: 1
 steps:
   deploy:
     image: scratch
@@ -272,11 +282,13 @@ func TestPipelineName(t *testing.T) {
 		Link:  "",
 		Yamls: []*forge_types.FileMeta{
 			{Name: ".woodpecker/lint.yml", Data: []byte(`
+version: 1
 steps:
   build:
     image: scratch
 `)},
 			{Name: ".woodpecker/.test.yml", Data: []byte(`
+version: 1
 steps:
   build:
     image: scratch
@@ -308,12 +320,14 @@ func TestBranchFilter(t *testing.T) {
 		Link:  "",
 		Yamls: []*forge_types.FileMeta{
 			{Data: []byte(`
+version: 1
 steps:
   xxx:
     image: scratch
 branches: main
 `)},
 			{Data: []byte(`
+version: 1
 steps:
   build:
     image: scratch
@@ -347,6 +361,7 @@ func TestRootWhenFilter(t *testing.T) {
 		Link:  "",
 		Yamls: []*forge_types.FileMeta{
 			{Data: []byte(`
+version: 1
 when:
   event:
     - tag
@@ -355,6 +370,7 @@ steps:
     image: scratch
 `)},
 			{Data: []byte(`
+version: 1
 when:
   event:
     - push
@@ -363,6 +379,7 @@ steps:
     image: scratch
 `)},
 			{Data: []byte(`
+version: 1
 steps:
   build:
     image: scratch
@@ -396,6 +413,7 @@ func TestZeroSteps(t *testing.T) {
 		Link:  "",
 		Yamls: []*forge_types.FileMeta{
 			{Data: []byte(`
+version: 1
 skip_clone: true
 steps:
   build:
@@ -431,6 +449,7 @@ func TestZeroStepsAsMultiPipelineDeps(t *testing.T) {
 		Link:  "",
 		Yamls: []*forge_types.FileMeta{
 			{Name: "zerostep", Data: []byte(`
+version: 1
 skip_clone: true
 steps:
   build:
@@ -439,11 +458,13 @@ steps:
     image: scratch
 `)},
 			{Name: "justastep", Data: []byte(`
+version: 1
 steps:
   build:
     image: scratch
 `)},
 			{Name: "shouldbefiltered", Data: []byte(`
+version: 1
 steps:
   build:
     image: scratch
@@ -480,6 +501,7 @@ func TestZeroStepsAsMultiPipelineTransitiveDeps(t *testing.T) {
 		Link:  "",
 		Yamls: []*forge_types.FileMeta{
 			{Name: "zerostep", Data: []byte(`
+version: 1
 skip_clone: true
 steps:
   build:
@@ -488,17 +510,20 @@ steps:
     image: scratch
 `)},
 			{Name: "justastep", Data: []byte(`
+version: 1
 steps:
   build:
     image: scratch
 `)},
 			{Name: "shouldbefiltered", Data: []byte(`
+version: 1
 steps:
   build:
     image: scratch
 depends_on: [ zerostep ]
 `)},
 			{Name: "shouldbefilteredtoo", Data: []byte(`
+version: 1
 steps:
   build:
     image: scratch

shared/constant/constant.go

@@ -40,3 +40,5 @@ var TrustedCloneImages = []string{
 	DefaultCloneImage,
 	"quay.io/woodpeckerci/plugin-git",
 }
+
+const DefaultPipelineVersion = 1