Skip to content

Commit

Permalink
Update README to latest format (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
Priyanka-Chatterjee-2000 authored Dec 13, 2023
1 parent 8bb9000 commit f08733c
Showing 1 changed file with 45 additions and 22 deletions.
67 changes: 45 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ Jira pipeline library for [Flowpipe](https://flowpipe.io), enabling seamless int

## Getting started

### Requirements

Docker daemon must be installed and running. Please see [Install Docker Engine](https://docs.docker.com/engine/install/) for more information.

### Installation

Download and install Flowpipe (https://flowpipe.io/downloads). Or use Brew:
Expand All @@ -21,13 +17,6 @@ brew tap turbot/tap
brew install flowpipe
```

Clone:

```sh
git clone https://github.com/turbot/flowpipe-mod-jira.git
cd flowpipe-mod-jira
```

### Credentials

By default, the following environment variables will be used for authentication:
Expand All @@ -54,35 +43,69 @@ For more information on credentials in Flowpipe, please see [Managing Credential

### Usage

List pipelines:
[Initialize a mod](https://flowpipe.io/docs/build/index#initializing-a-mod):

```sh
flowpipe pipeline list
mkdir my_mod
cd my_mod
flowpipe mod init
```

Run a pipeline:
[Install the Jira mod](https://flowpipe.io/docs/build/mod-dependencies#mod-dependencies) as a dependency:

```sh
flowpipe pipeline run list_issues
flowpipe mod install github.com/turbot/flowpipe-mod-jira
```

You can pass in pipeline arguments as well:
[Use the dependency](https://flowpipe.io/docs/build/write-pipelines/index) in a pipeline step:

```sh
flowpipe pipeline run list_issues --arg project_key=SBT
vi my_pipeline.fp
```

To use a specific `credential`, specify the `cred` pipeline argument:
```hcl
pipeline "my_pipeline" {
step "pipeline" "list_issues" {
pipeline = jira.pipeline.list_issues
args = {
project_key = "SBT"
}
}
}
```
[Run the pipeline](https://flowpipe.io/docs/run/pipelines):

```sh
flowpipe pipeline run list_issues --arg cred=jira_cred --arg project_key=SBT
flowpipe pipeline run my_pipeline
```

For more examples on how you can run pipelines, please see [Run Pipelines](https://flowpipe.io/docs/run/pipelines).
### Developing

### Configuration
Clone:

No additional configuration is required.
```sh
git clone https://github.com/turbot/flowpipe-mod-jira.git
cd flowpipe-mod-jira
```

List pipelines:

```sh
flowpipe pipeline list
```

Run a pipeline:

```sh
flowpipe pipeline run list_issues --arg project_key=SBT
```

To use a specific `credential`, specify the `cred` pipeline argument:

```sh
flowpipe pipeline run list_issues --arg cred=jira_profile --arg project_key=SBT
```

## Open Source & Contributing

Expand Down

0 comments on commit f08733c

Please sign in to comment.