Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme and development docs #156

Merged
merged 1 commit into from
May 14, 2024
Merged

Update readme and development docs #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
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
View file
Open in desktop
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
```
Loading