codefresh 0.87.0 → 0.87.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/release-drafter.yaml +8 -0
- package/.github/workflows/draft-release.yaml +33 -0
- package/docs/content/pipelines/spec.md +138 -64
- package/lib/interface/cli/commands/trigger/create.cmd.js +2 -2
- package/lib/interface/cli/commands/trigger/delete.cmd.js +1 -1
- package/lib/interface/cli/commands/trigger/event/create.cmd.js +2 -2
- package/lib/interface/cli/commands/trigger/event/delete.cmd.js +2 -2
- package/lib/interface/cli/commands/trigger/event/get.cmd.js +2 -2
- package/lib/interface/cli/commands/trigger/get.cmd.js +2 -2
- package/lib/interface/cli/commands/trigger/type/get.cmd.js +2 -2
- package/package.json +1 -1
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
name-template: 'v$RESOLVED_VERSION'
|
|
2
|
+
tag-template: 'v$RESOLVED_VERSION'
|
|
3
|
+
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
|
|
4
|
+
change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
|
|
5
|
+
template: |
|
|
6
|
+
## Changes
|
|
7
|
+
|
|
8
|
+
$CHANGES
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
## Reference: https://github.com/release-drafter/release-drafter
|
|
2
|
+
name: Create Release
|
|
3
|
+
|
|
4
|
+
on:
|
|
5
|
+
push:
|
|
6
|
+
branches:
|
|
7
|
+
- master
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
create_release:
|
|
11
|
+
name: Create Release
|
|
12
|
+
runs-on: ubuntu-latest
|
|
13
|
+
steps:
|
|
14
|
+
- name: Checkout
|
|
15
|
+
uses: actions/checkout@v3
|
|
16
|
+
with:
|
|
17
|
+
fetch-depth: 0
|
|
18
|
+
|
|
19
|
+
- name: Set up jq
|
|
20
|
+
uses: dcarbone/install-jq-action@v1.0.1
|
|
21
|
+
|
|
22
|
+
- name: Get release version from service.yaml
|
|
23
|
+
run: |
|
|
24
|
+
RELEASE_VERSION=$(jq -r '.version' package.json )
|
|
25
|
+
echo "RELEASE_VERSION=$RELEASE_VERSION" >> $GITHUB_ENV
|
|
26
|
+
|
|
27
|
+
- uses: release-drafter/release-drafter@v5
|
|
28
|
+
env:
|
|
29
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
30
|
+
with:
|
|
31
|
+
publish: true
|
|
32
|
+
version: ${{ env.RELEASE_VERSION }}
|
|
33
|
+
config-name: release-drafter.yaml
|
|
@@ -8,79 +8,169 @@ A Pipeline also needs a `.spec` section.
|
|
|
8
8
|
|
|
9
9
|
### Examples
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Use create/replace/delete commands to manage your pipeline
|
|
12
|
+
|
|
13
|
+
```shell
|
|
14
|
+
# create pipeline
|
|
15
|
+
codefresh create -f pipeline.yaml
|
|
16
|
+
|
|
17
|
+
# get created/modified pipeline spec
|
|
18
|
+
codefresh get pipeline <name> -o yaml > pipeline.yaml
|
|
19
|
+
|
|
20
|
+
# update pipeline with modified pipeline spec
|
|
21
|
+
codefresh replace -f pipeline.yaml
|
|
22
|
+
|
|
23
|
+
# delete pipeline using spec file
|
|
24
|
+
codefresh delete -f pipeline.yaml
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
See the examples of pipeline spec below to manage your pipelines.
|
|
28
|
+
|
|
29
|
+
#### Basic pipeline with cron triggers in spec
|
|
30
|
+
|
|
31
|
+
```yaml
|
|
32
|
+
version: '1.0'
|
|
33
|
+
kind: pipeline
|
|
34
|
+
metadata:
|
|
35
|
+
name: cron
|
|
36
|
+
spec:
|
|
37
|
+
cronTriggers:
|
|
38
|
+
- name: every minute
|
|
39
|
+
type: cron
|
|
40
|
+
message: every minute
|
|
41
|
+
expression: 0/1 * 1/1 * *
|
|
42
|
+
steps:
|
|
43
|
+
test:
|
|
44
|
+
image: alpine
|
|
45
|
+
commands:
|
|
46
|
+
- echo test
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
#### Basic pipeline with cron triggers with variables
|
|
50
|
+
|
|
51
|
+
```yaml
|
|
52
|
+
version: '1.0'
|
|
53
|
+
kind: pipeline
|
|
54
|
+
metadata:
|
|
55
|
+
name: cron
|
|
56
|
+
spec:
|
|
57
|
+
cronTriggers:
|
|
58
|
+
- name: every minute
|
|
59
|
+
type: cron
|
|
60
|
+
message: every minute
|
|
61
|
+
expression: 0/1 * 1/1 * *
|
|
62
|
+
variables:
|
|
63
|
+
- key: TEST_VAR
|
|
64
|
+
value: 'my-test'
|
|
65
|
+
steps:
|
|
66
|
+
test:
|
|
67
|
+
image: alpine
|
|
68
|
+
commands:
|
|
69
|
+
- echo ${{TEST_VARIABLE}}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
#### Basic pipeline with cron triggers with run options
|
|
73
|
+
|
|
74
|
+
```yaml
|
|
75
|
+
version: '1.0'
|
|
76
|
+
kind: pipeline
|
|
77
|
+
metadata:
|
|
78
|
+
name: cron
|
|
79
|
+
spec:
|
|
80
|
+
cronTriggers:
|
|
81
|
+
- name: every minute
|
|
82
|
+
type: cron
|
|
83
|
+
message: every minute
|
|
84
|
+
expression: 0/1 * 1/1 * *
|
|
85
|
+
options:
|
|
86
|
+
resetVolume: true
|
|
87
|
+
steps:
|
|
88
|
+
test:
|
|
89
|
+
image: alpine
|
|
90
|
+
commands:
|
|
91
|
+
- echo test >> test.txt
|
|
92
|
+
- cat test.txt
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
#### Pipeline started by cron trigger but simulating the git trigger
|
|
96
|
+
|
|
97
|
+
Note that `spec.triggers.0.id` and `spec.cronTriggers.gitTriggerId`
|
|
98
|
+
should be the same value and a valid ObjectId.
|
|
12
99
|
|
|
13
100
|
```yaml
|
|
14
101
|
version: '1.0'
|
|
15
102
|
kind: pipeline
|
|
16
103
|
metadata:
|
|
17
|
-
name:
|
|
18
|
-
labels:
|
|
19
|
-
tags: []
|
|
20
|
-
deprecate:
|
|
21
|
-
applicationPort: '8080'
|
|
22
|
-
repoPipeline: true
|
|
104
|
+
name: cron
|
|
23
105
|
spec:
|
|
24
106
|
triggers:
|
|
25
107
|
- type: git
|
|
26
|
-
|
|
108
|
+
name: test
|
|
109
|
+
repo: repo-owner/repo-name
|
|
27
110
|
events:
|
|
28
111
|
- push.heads
|
|
29
112
|
pullRequestAllowForkEvents: false
|
|
30
113
|
commentRegex: /.*/gi
|
|
31
114
|
branchRegex: /.*/gi
|
|
32
115
|
branchRegexInput: regex
|
|
33
|
-
provider:
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
116
|
+
provider: git-context-name
|
|
117
|
+
id: 65329431edb87250ff128acc
|
|
118
|
+
|
|
119
|
+
cronTriggers:
|
|
120
|
+
- name: every minute
|
|
121
|
+
type: cron
|
|
122
|
+
message: every minute
|
|
123
|
+
expression: 0/1 * 1/1 * *
|
|
124
|
+
gitTriggerId: 65329431edb87250ff128acc
|
|
125
|
+
branch: master
|
|
126
|
+
|
|
41
127
|
steps:
|
|
42
|
-
|
|
128
|
+
test:
|
|
43
129
|
image: alpine
|
|
44
|
-
working_directory: '${{clone_step}}'
|
|
45
130
|
commands:
|
|
46
|
-
- echo
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
131
|
+
- echo ${{CF_BRANCH}}
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
#### **Disable** cron trigger in pipeline
|
|
135
|
+
|
|
136
|
+
```yaml
|
|
137
|
+
version: '1.0'
|
|
138
|
+
kind: pipeline
|
|
139
|
+
metadata:
|
|
140
|
+
name: cron
|
|
141
|
+
spec:
|
|
142
|
+
cronTriggers:
|
|
143
|
+
- name: every minute
|
|
144
|
+
type: cron
|
|
145
|
+
message: every minute
|
|
146
|
+
expression: 0/1 * 1/1 * *
|
|
147
|
+
disabled: true
|
|
148
|
+
steps:
|
|
149
|
+
test:
|
|
150
|
+
image: alpine
|
|
151
|
+
commands:
|
|
152
|
+
- echo test
|
|
58
153
|
```
|
|
59
154
|
|
|
60
|
-
#### Basic Pipeline with
|
|
155
|
+
#### Basic Pipeline with clone step and git trigger
|
|
61
156
|
|
|
62
157
|
```yaml
|
|
63
158
|
version: '1.0'
|
|
64
159
|
kind: pipeline
|
|
65
160
|
metadata:
|
|
66
|
-
name:
|
|
67
|
-
labels:
|
|
68
|
-
tags: []
|
|
69
|
-
deprecate:
|
|
70
|
-
applicationPort: '8080'
|
|
71
|
-
repoPipeline: true
|
|
161
|
+
name: basic-pipeline
|
|
72
162
|
spec:
|
|
73
163
|
triggers:
|
|
74
164
|
- type: git
|
|
75
|
-
|
|
165
|
+
name: test
|
|
166
|
+
repo: repo-owner/repo-name
|
|
76
167
|
events:
|
|
77
168
|
- push.heads
|
|
78
169
|
pullRequestAllowForkEvents: false
|
|
79
170
|
commentRegex: /.*/gi
|
|
80
171
|
branchRegex: /.*/gi
|
|
81
172
|
branchRegexInput: regex
|
|
82
|
-
provider:
|
|
83
|
-
contexts: []
|
|
173
|
+
provider: git-context-name
|
|
84
174
|
variables:
|
|
85
175
|
- key: PORT
|
|
86
176
|
value: '3000'
|
|
@@ -108,7 +198,6 @@ spec:
|
|
|
108
198
|
dockerfile: ./Dockerfile
|
|
109
199
|
image_name: my-custom-docker-image
|
|
110
200
|
tag: bla
|
|
111
|
-
stages: []
|
|
112
201
|
```
|
|
113
202
|
|
|
114
203
|
#### Pipeline with a remote spec template brought from a git repository
|
|
@@ -116,24 +205,19 @@ spec:
|
|
|
116
205
|
version: '1.0'
|
|
117
206
|
kind: pipeline
|
|
118
207
|
metadata:
|
|
119
|
-
name:
|
|
120
|
-
isPublic: false
|
|
121
|
-
labels:
|
|
122
|
-
tags: []
|
|
123
|
-
deprecate:
|
|
124
|
-
applicationPort: '8080'
|
|
125
|
-
repoPipeline: true
|
|
208
|
+
name: basic-pipeline
|
|
126
209
|
spec:
|
|
127
210
|
triggers:
|
|
128
211
|
- type: git
|
|
129
|
-
|
|
212
|
+
name: test
|
|
213
|
+
repo: repo-owner/repo-name
|
|
130
214
|
events:
|
|
131
215
|
- push.heads
|
|
132
216
|
pullRequestAllowForkEvents: false
|
|
133
217
|
commentRegex: /.*/gi
|
|
134
218
|
branchRegex: /.*/gi
|
|
135
219
|
branchRegexInput: regex
|
|
136
|
-
provider:
|
|
220
|
+
provider: git-context-name
|
|
137
221
|
contexts: []
|
|
138
222
|
variables:
|
|
139
223
|
- key: PORT
|
|
@@ -147,8 +231,6 @@ spec:
|
|
|
147
231
|
repo: codefresh-io/cli
|
|
148
232
|
path: codefresh.yml
|
|
149
233
|
revision: master # can be a branch or commit. if not specified will use CF_BRANCH variable value
|
|
150
|
-
steps: {}
|
|
151
|
-
stages: []
|
|
152
234
|
```
|
|
153
235
|
|
|
154
236
|
#### Pipeline with a remote spec template from a public git URL
|
|
@@ -156,25 +238,19 @@ spec:
|
|
|
156
238
|
version: '1.0'
|
|
157
239
|
kind: pipeline
|
|
158
240
|
metadata:
|
|
159
|
-
name:
|
|
160
|
-
isPublic: false
|
|
161
|
-
labels:
|
|
162
|
-
tags: []
|
|
163
|
-
deprecate:
|
|
164
|
-
applicationPort: '8080'
|
|
165
|
-
repoPipeline: true
|
|
166
|
-
project: codefresh-io/cli
|
|
241
|
+
name: basic-pipeline
|
|
167
242
|
spec:
|
|
168
243
|
triggers:
|
|
169
244
|
- type: git
|
|
170
|
-
|
|
245
|
+
name: test
|
|
246
|
+
repo: repo-owner/repo-name
|
|
171
247
|
events:
|
|
172
248
|
- push.heads
|
|
173
249
|
pullRequestAllowForkEvents: false
|
|
174
250
|
commentRegex: /.*/gi
|
|
175
251
|
branchRegex: /.*/gi
|
|
176
252
|
branchRegexInput: regex
|
|
177
|
-
provider:
|
|
253
|
+
provider: git-context-name
|
|
178
254
|
contexts: []
|
|
179
255
|
variables:
|
|
180
256
|
- key: PORT
|
|
@@ -185,6 +261,4 @@ spec:
|
|
|
185
261
|
specTemplate:
|
|
186
262
|
location: url
|
|
187
263
|
url: 'https://raw.githubusercontent.com/codefresh-io/cli/master/codefresh.yml'
|
|
188
|
-
steps: {}
|
|
189
|
-
stages: []
|
|
190
264
|
```
|
|
@@ -9,10 +9,10 @@ const command = new Command({
|
|
|
9
9
|
command: 'trigger [event-uri] [pipeline]',
|
|
10
10
|
aliases: ['t'],
|
|
11
11
|
parent: createRoot,
|
|
12
|
-
description: 'Create trigger: link pipeline to `trigger-event
|
|
12
|
+
description: '[Deprecated] Create trigger: link pipeline to `trigger-event`. Deprecated - please use pipeline spec to manager cron trigger',
|
|
13
13
|
webDocs: {
|
|
14
14
|
category: 'Triggers',
|
|
15
|
-
title: 'Create Pipeline Trigger',
|
|
15
|
+
title: '[Deprecated] Create Pipeline Trigger',
|
|
16
16
|
weight: 5,
|
|
17
17
|
},
|
|
18
18
|
builder: (yargs) => {
|
|
@@ -11,7 +11,7 @@ const command = new Command({
|
|
|
11
11
|
description: 'Delete trigger: unlink pipeline from `trigger-event`',
|
|
12
12
|
webDocs: {
|
|
13
13
|
category: 'Triggers',
|
|
14
|
-
title: 'Delete Pipeline Trigger',
|
|
14
|
+
title: '[Deprecated] Delete Pipeline Trigger. Deprecated - please use pipeline spec to manager cron trigger',
|
|
15
15
|
weight: 20,
|
|
16
16
|
},
|
|
17
17
|
builder: (yargs) => {
|
|
@@ -9,10 +9,10 @@ const command = new Command({
|
|
|
9
9
|
command: 'trigger-event',
|
|
10
10
|
aliases: ['te'],
|
|
11
11
|
parent: createRoot,
|
|
12
|
-
description: 'Create new `trigger-event
|
|
12
|
+
description: '[Deprecated] Create new `trigger-event`. Deprecated - please use pipeline spec to manager cron trigger',
|
|
13
13
|
webDocs: {
|
|
14
14
|
category: 'Triggers',
|
|
15
|
-
title: 'Create Trigger Event',
|
|
15
|
+
title: '[Deprecated] Create Trigger Event',
|
|
16
16
|
},
|
|
17
17
|
builder: (yargs) => {
|
|
18
18
|
yargs
|
|
@@ -8,10 +8,10 @@ const command = new Command({
|
|
|
8
8
|
command: 'trigger-event [event-uri]',
|
|
9
9
|
aliases: ['te'],
|
|
10
10
|
parent: deleteRoot,
|
|
11
|
-
description: 'Delete `trigger-event
|
|
11
|
+
description: '[Deprecated] Delete `trigger-event`. Deprecated - please use pipeline spec to manager cron trigger',
|
|
12
12
|
webDocs: {
|
|
13
13
|
category: 'Triggers',
|
|
14
|
-
title: 'Delete Trigger Event',
|
|
14
|
+
title: '[Deprecated] Delete Trigger Event',
|
|
15
15
|
},
|
|
16
16
|
builder: (yargs) => {
|
|
17
17
|
yargs
|
|
@@ -11,10 +11,10 @@ const command = new Command({
|
|
|
11
11
|
command: 'trigger-events [event-uri]',
|
|
12
12
|
aliases: ['trigger-event', 'te'],
|
|
13
13
|
parent: getRoot,
|
|
14
|
-
description: 'Get `trigger-event
|
|
14
|
+
description: '[Deprecated] Get `trigger-event`. Deprecated - please use pipeline spec to manager cron trigger',
|
|
15
15
|
webDocs: {
|
|
16
16
|
category: 'Triggers',
|
|
17
|
-
title: 'Get Trigger Event',
|
|
17
|
+
title: '[Deprecated] Get Trigger Event',
|
|
18
18
|
},
|
|
19
19
|
builder: (yargs) => {
|
|
20
20
|
yargs
|
|
@@ -10,11 +10,11 @@ const command = new Command({
|
|
|
10
10
|
command: 'triggers',
|
|
11
11
|
aliases: ['trigger', 't'],
|
|
12
12
|
parent: getRoot,
|
|
13
|
-
description: 'Get triggers, optionally filtered by pipeline or event.',
|
|
13
|
+
description: '[Deprecated] Get triggers, optionally filtered by pipeline or event. Deprecated - please use pipeline spec to manager cron triggers',
|
|
14
14
|
usage: 'Only cron/registry triggers are supported (for git triggers use `codefresh get pip <pip-name> -o json`)',
|
|
15
15
|
webDocs: {
|
|
16
16
|
category: 'Triggers',
|
|
17
|
-
title: 'Get Triggers',
|
|
17
|
+
title: '[Deprecated] Get Triggers',
|
|
18
18
|
},
|
|
19
19
|
builder: (yargs) => {
|
|
20
20
|
yargs
|
|
@@ -11,10 +11,10 @@ const command = new Command({
|
|
|
11
11
|
command: 'trigger-types',
|
|
12
12
|
aliases: ['trigger-type', 'tt'],
|
|
13
13
|
parent: getRoot,
|
|
14
|
-
description: 'Get a list of available trigger-types',
|
|
14
|
+
description: '[Deprecated] Get a list of available trigger-types. Deprecated - please use pipeline spec to manager cron trigger',
|
|
15
15
|
webDocs: {
|
|
16
16
|
category: 'Triggers',
|
|
17
|
-
title: 'Get Trigger Types',
|
|
17
|
+
title: '[Deprecated] Get Trigger Types',
|
|
18
18
|
},
|
|
19
19
|
builder: (yargs) => {
|
|
20
20
|
yargs
|