Skip to content

Commit 8f64ba6

Browse files
author
Akshay Dewan
committed
Update readme with new format_version
1 parent be5d813 commit 8f64ba6

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,18 @@ you can find examples of correct environments [below](#environment).
121121

122122
Please note that it is now recommended to declare the _same_ `format_version` in each `*.gopipeline.json` or `*.goenvironment.json` file.
123123

124+
#### GoCD server version from 19.10.0 and beyond
125+
126+
Supports `format_version` value of `9`. In this version, support of `ignore_for_scheduling` for [dependency materials](#dependency) has been added. Setting this attribute will skip scheduling the pipeline when the dependency material has changed.
127+
128+
Using a newer `format_version` includes all the behavior of the previous versions too.
129+
130+
#### GoCD server version from 19.9.0 and beyond
131+
132+
Supports `format_version` value of `7` and `8`. In version `7`, support for [properties](#property) has been removed. In version `8`, support for [mingle](#mingle) has been removed.
133+
134+
Using a newer `format_version` includes all the behavior of the previous versions too.
135+
124136
#### GoCD server version from 19.8.0 and beyond
125137

126138
Supports `format_version` value of `6`. In this version, support of `allow_only_on_success` for [approval](#approval) on stage has been added. Setting this attribute will ensure that the manual trigger will be allowed only if the previous stage is successful.
@@ -208,10 +220,6 @@ Any variable must contain `name` and `value` or `encrypted_value`.
208220
"value": "parameter"
209221
}
210222
],
211-
"mingle": {
212-
"base_url": "http://mingle.example.com",
213-
"project_identifier": "my_project"
214-
},
215223
"tracking_tool": null,
216224
"timer": {
217225
"spec": "0 15 10 * * ? *"
@@ -310,6 +318,7 @@ In the above example, since both pipelines are in the same group, `pipeline2` wi
310318
```
311319

312320
### Mingle
321+
**Note: Since GoCD version 19.9 and format_version 8, this is no longer supported**
313322

314323
```json
315324
{
@@ -397,13 +406,6 @@ In the above example, since both pipelines are in the same group, `pipeline2` wi
397406
]
398407
}
399408
],
400-
"properties": [
401-
{
402-
"name": "perf",
403-
"source": "test.xml",
404-
"xpath": "substring-before(//report/data/all/coverage[starts-with(@type,\u0027class\u0027)]/@value, \u0027%\u0027)"
405-
}
406-
],
407409
"tasks": [
408410
...
409411
]
@@ -464,6 +466,7 @@ The external artifact store is referenced by the `store_id`. The build specific
464466
```
465467

466468
### Property
469+
**Note: Since GoCD version 19.9 and format_version 7, properties are no longer supported**
467470

468471
```json
469472
{
@@ -700,7 +703,8 @@ Instead of `encrypted_password` you may specify `password` but `encrypted_passwo
700703
"pipeline": "pipeline2",
701704
"stage": "build",
702705
"name": "pipe2",
703-
"type": "dependency"
706+
"type": "dependency",
707+
"ignore_for_scheduling": false
704708
}
705709
```
706710

0 commit comments

Comments
 (0)