Skip to content

Commit 46c5bdc

Browse files
mbpavanopenshift-merge-bot[bot]
authored andcommitted
add group support to readme
1 parent e7419ae commit 46c5bdc

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ You can refer the ApprovalTask in the pipeline similar to how we refer Task toda
1212
params:
1313
- name: approvers
1414
value:
15-
- foo
16-
- bar
17-
- tekton
15+
- foo # individual user
16+
- bar
17+
- tekton
18+
- group:tekton # users in group
19+
- group:example
1820
- name: numberOfApprovalsRequired
1921
value: 2
2022
- name: description
@@ -33,6 +35,15 @@ You can refer the ApprovalTask in the pipeline similar to how we refer Task toda
3335
* If any one approver rejects the approval task controller will mark the approvalState as rejected and then the pipelinerun will fail
3436
* If a user approves for the first time and still approvalsRequired limit is not reached i.e. approvalState is in pending state then user can still change his input and mark the approval task as reject
3537
38+
* Support for approver groups
39+
* Define groups of users as approvers, using the group:<groupName> syntax.
40+
41+
* Individual & Group Approvers
42+
* Mix single users (alice, bob) and groups (group:dev-team, group:qa-team) in the approval list.
43+
44+
* Approval messages
45+
* Approvers can add a custom message when approving or rejecting.
46+
3647
* A webhook is configured while you install manual-approval-gate which will take care of all the checks which are required while the approver approves/rejects the approvalTask
3748
* Users can add timeout to the approvalTask
3849
* As of today once the timeout exceeds, approvalTask state is marked as rejected and correspondingly customrun and pipelinerun will be failed

0 commit comments

Comments
 (0)