diff --git a/README.md b/README.md index d0040221..d55a0fd8 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/DEVELOPEMENT.md b/docs/DEVELOPEMENT.md index 936a1f02..b41e769e 100644 --- a/docs/DEVELOPEMENT.md +++ b/docs/DEVELOPEMENT.md @@ -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 --as= - ``` \ No newline at end of file + ```shell + tkn-approvaltask approve ---> 👈🏻 To approve the approvaltask + tkn-approvaltask reject ---> 👈🏻 To reject the approvaltask + ```