Skip to content

Commit

Permalink
Update readme and development docs
Browse files Browse the repository at this point in the history
Signed-off-by: PuneetPunamiya <[email protected]>
  • Loading branch information
PuneetPunamiya authored and piyush-garg committed May 14, 2024
1 parent 1c7daa3 commit 1c14201
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ You can refer the ApprovalTask in the pipeline similar to how we refer Task toda
* Users can add timeout to the approvalTask
* As of today once the timeout exceeds, approvalTask state is marked as rejected and correspondingly customrun and pipelinerun will be failed
* Users can add messages while approving/rejecting the approvalTask
* `tkn-approvaltask` CLI for managing approvaltasks

### Installation

Expand Down
20 changes: 10 additions & 10 deletions docs/DEVELOPEMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,16 +64,16 @@ NOTE:- You need to install [tektoncd/pipeline](https://github.com/tektoncd/pipel
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_
3. Now `approve/reject` the approval task by using `kubectl edit` command by updating the `input` field under `approvers` section fo your username
3. Once the approvaltask is created, you can use `tkn-approvaltask` CLI to list and describe the approvaltask
To get the approvalTask name you can use this command
```bash
kubectl get approvaltask
```
```shell
tkn-approvaltask list ---> πŸ‘ˆπŸ» To list the approvaltask
tkn-approvaltask describe ---> πŸ‘ˆπŸ» To describe the approvaltask
```

**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
4. Now `approve/reject` the approvaltask using `tkn-approvaltask` plugin

```bash
kubectl edit approvaltask <approvalTaskname> --as=<username>
```
```shell
tkn-approvaltask approve ---> πŸ‘ˆπŸ» To approve the approvaltask
tkn-approvaltask reject ---> πŸ‘ˆπŸ» To reject the approvaltask
```

0 comments on commit 1c14201

Please sign in to comment.