1
0
mirror of https://github.com/robbyrussell/oh-my-zsh.git synced 2026-02-13 04:40:59 +01:00

create the circleci plugin

This commit is contained in:
Siddharth Agrawal
2022-10-18 16:54:26 +05:30
parent 5bce72ef57
commit a86e5876eb
3 changed files with 106 additions and 0 deletions

View File

@@ -0,0 +1,23 @@
# CircleCi Plugin
This plugin provides easy to use cli commands to query circle ci job statuses
To use it, add `circleci` to the plugins array in your zshrc file:
```zsh
plugins=(... circleci)
```
## Prerequisites
You need to have the `CIRCLECI_API_TOKEN` and `CIRCLECI_ORG_SLUG` as environment
variables before calling the `circleci_status` function <br>
You can learn how to add a circleci api token [here](https://circleci.com/docs/managing-api-tokens/) <br>
The org slug takes the format of `{vcs}/{org_name}`
## Usage
```shell
> circleci_status
```
The above command would list down all the jobs (with their run status) on the
repository and branch that you are currently on <br>
You can also use the `cis` alias to run the above function