Skip to content

Commit 248ff08

Browse files
PuneetPunamiyambpavan
authored andcommitted
Fix docs based on the design of ApprovalTask
Signed-off-by: PuneetPunamiya <[email protected]>
1 parent d8fee75 commit 248ff08

File tree

2 files changed

+13
-22
lines changed

2 files changed

+13
-22
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You can refer the ApprovalTask in the pipeline similar to how we refer Task toda
1515
- foo # individual user
1616
- bar
1717
- tekton
18-
- group:tekton # users in group
18+
- group:tekton # groupName
1919
- group:example
2020
- name: numberOfApprovalsRequired
2121
value: 2

docs/APPROVAL_TASK_GUIDE.md

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ spec:
3636
message: ""
3737
- name: dev-team
3838
type: Group
39-
input: pending
39+
input: approve
4040
message: ""
4141
users:
4242
- name: charlie
43-
input: pending
43+
input: approve
4444
- name: diana
45-
input: pending
45+
input: approve
4646
numberOfApprovalsRequired: 2
4747
description: "Approve deployment to production environment"
4848
status:
@@ -140,15 +140,15 @@ spec:
140140
approvers:
141141
- name: dev-team
142142
type: Group
143-
input: pending
144-
users:
143+
input: reject
144+
users: # Users from the group are only added if the approve/reject
145145
- name: alice
146-
input: pending
146+
input: approve
147147
- name: bob
148-
input: pending
148+
input: approve
149149
- name: charlie
150-
input: pending
151-
numberOfApprovalsRequired: 1
150+
input: reject
151+
numberOfApprovalsRequired: 3
152152
description: "Any member of dev-team can approve"
153153
```
154154

@@ -172,17 +172,12 @@ spec:
172172
input: pending
173173
users:
174174
- name: tester1
175-
input: pending
175+
input: approve
176176
- name: tester2
177-
input: pending
177+
input: approve
178178
- name: security-team
179179
type: Group
180180
input: pending
181-
users:
182-
- name: security-lead
183-
input: pending
184-
- name: security-analyst
185-
input: pending
186181
numberOfApprovalsRequired: 3
187182
description: "Requires tech lead + QA team member + security team member"
188183
```
@@ -246,11 +241,7 @@ status:
246241
message: "LGTM for production deployment"
247242
- name: bob
248243
type: User
249-
response: pending
250-
- name: security-team
251-
type: Group
252-
response: pending
253-
groupMembers: []
244+
response: approved
254245
```
255246

256247
### Approved State

0 commit comments

Comments
 (0)