Add workflow version

.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: pull_request
  - event: push

.woodpecker/release-helper.yml

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

.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/error.go

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

pipeline/frontend/yaml/linter/linter_test.go

@@ -23,6 +23,7 @@ import (
 func TestLint(t *testing.T) {
  testdatas := []struct{ Title, Data string }{{
  Title: "map", Data: `
+version: 1
 steps:
  build:
  image: docker
@@ -44,6 +45,7 @@ services:
 `,
  }, {
  Title: "list", Data: `
+version: 1
 steps:
  - name: build
  image: docker
@@ -62,6 +64,7 @@ steps:
 `,
  }, {
  Title: "merge maps", Data: `
+version: 1
 variables:
  step_template: &base-step
  image: golang:1.19
@@ -151,7 +154,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/parse.go

@@ -22,12 +22,20 @@ import (
 
 // ParseBytes parses the configuration from bytes b.
 func ParseBytes(b []byte) (*types.Workflow, error) {
+ yamlVersion, err := checkVersion(b)
+ if err != nil {
+ return nil, &PipelineParseError{Err: err}
+ }
+
  out := new(types.Workflow)
- err := xyaml.Unmarshal(b, out)
+ 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
+
  return out, nil
 }
 
@@ -37,3 +45,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 1, nil
+ }
+
+ if ver.Version != Version {
+ return 0, ErrUnsuportedVersion
+ }
+ return ver.Version, nil
+}

pipeline/frontend/yaml/parse_test.go

@@ -87,6 +87,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)
@@ -138,6 +148,7 @@ func TestParse(t *testing.T) {
 }
 
 var sampleYaml = `
+version: 1
 image: hello-world
 when:
  - event:
@@ -189,7 +200,14 @@ runs_on:
  - failure
 `
 
+var sampleYamlDefaultVersion = `
+steps:
+ - name: notify_success
+ image: xyz
+`
+
 var simpleYamlAnchors = `
+version: 1
 vars:
  image: &image plugins/slack
 steps:
@@ -198,6 +216,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 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

pipeline/schema/.woodpecker/test-branches-array.yml

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

pipeline/schema/.woodpecker/test-branches-exclude-include.yml

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

pipeline/schema/.woodpecker/test-branches.yml

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

pipeline/schema/.woodpecker/test-broken.yml

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

pipeline/schema/.woodpecker/test-clone-skip.yml

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

pipeline/schema/.woodpecker/test-clone.yml

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

pipeline/schema/.woodpecker/test-labels.yml

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

pipeline/schema/.woodpecker/test-matrix.yml

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

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

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

pipeline/schema/.woodpecker/test-multi.yml

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

pipeline/schema/.woodpecker/test-pipeline-when.yml

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

pipeline/schema/.woodpecker/test-platform.yml

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

pipeline/schema/.woodpecker/test-plugin.yml

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

pipeline/schema/.woodpecker/test-run-on.yml

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

pipeline/schema/.woodpecker/test-service.yml

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

pipeline/schema/.woodpecker/test-step.yml

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

pipeline/schema/.woodpecker/test-when.yml

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

pipeline/schema/.woodpecker/test-workspace.yml

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

pipeline/schema/schema.json

@@ -19,7 +19,7 @@
  "branches": { "$ref": "#/definitions/branches" },
  "when": { "$ref": "#/definitions/pipeline_when" },
  "steps": { "$ref": "#/definitions/step_list" },
- "pipeline": { "$ref": "#/definitions/step_list", "description": "depricated, use steps" },
+ "pipeline": { "$ref": "#/definitions/step_list", "description": "deprecated, use steps" },
  "services": { "$ref": "#/definitions/services" },
  "workspace": { "$ref": "#/definitions/workspace" },
  "matrix": { "$ref": "#/definitions/matrix" },
@@ -34,7 +34,8 @@
  "type": "array",
  "minLength": 1,
  "items": { "type": "string" }
- }
+ },
+ "version": { "type": "number", "default": 1 }
  },
  "definitions": {
  "clone": {