Skip to content

Commit 1c14201

Browse files
PuneetPunamiyapiyush-garg
authored andcommitted
Update readme and development docs
Signed-off-by: PuneetPunamiya <[email protected]>
1 parent 1c7daa3 commit 1c14201

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ You can refer the ApprovalTask in the pipeline similar to how we refer Task toda
3737
* Users can add timeout to the approvalTask
3838
* As of today once the timeout exceeds, approvalTask state is marked as rejected and correspondingly customrun and pipelinerun will be failed
3939
* Users can add messages while approving/rejecting the approvalTask
40-
40+
* `tkn-approvaltask` CLI for managing approvaltasks
4141

4242
### Installation
4343

docs/DEVELOPEMENT.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,16 @@ NOTE:- You need to install [tektoncd/pipeline](https://github.com/tektoncd/pipel
6464
As of today only `"approve"` and `"reject"` are supported. If user passes the approval as `"approve"` then pipeline will proceed to execute the further tasks and if `"reject"` is provided then in that case it will fail the pipeline_
6565
6666
67-
3. Now `approve/reject` the approval task by using `kubectl edit` command by updating the `input` field under `approvers` section fo your username
67+
3. Once the approvaltask is created, you can use `tkn-approvaltask` CLI to list and describe the approvaltask
6868
69-
To get the approvalTask name you can use this command
70-
71-
```bash
72-
kubectl get approvaltask
73-
```
69+
```shell
70+
tkn-approvaltask list ---> 👈🏻 To list the approvaltask
71+
tkn-approvaltask describe ---> 👈🏻 To describe the approvaltask
72+
```
7473

75-
**NOTE** :- If you are using a kind cluster and you need to approve/reject for that particular user then in that case you can run the following command
74+
4. Now `approve/reject` the approvaltask using `tkn-approvaltask` plugin
7675

77-
```bash
78-
kubectl edit approvaltask <approvalTaskname> --as=<username>
79-
```
76+
```shell
77+
tkn-approvaltask approve ---> 👈🏻 To approve the approvaltask
78+
tkn-approvaltask reject ---> 👈🏻 To reject the approvaltask
79+
```

0 commit comments

Comments
 (0)