Skip to content

Latest commit

 

History

History
130 lines (86 loc) · 3.35 KB

README.md

File metadata and controls

130 lines (86 loc) · 3.35 KB
Raw

GitHub Mod for Flowpipe

GitHub pipeline library for Flowpipe, enabling seamless integration of GitHub services into your workflows.

Documentation

Getting Started

Installation

Download and install Flowpipe (https://flowpipe.io/downloads). Or use Brew:

brew tap turbot/tap
brew install flowpipe

Clone:

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

Connections

By default, the following environment variables will be used for authentication:

  • GITHUB_TOKEN

You can also create connection resources in configuration files:

vi ~/.flowpipe/config/github.fpc
connection "github" "default" {
  token = "ghp_..."
}

For more information on connections in Flowpipe, please see Managing Connections.

Usage

Initialize a mod:

mkdir my_mod
cd my_mod
flowpipe mod init

Install the GitHub mod as a dependency:

flowpipe mod install github.com/turbot/flowpipe-mod-github

Use the dependency in a pipeline step:

vi my_pipeline.fp
pipeline "my_pipeline" {

  step "pipeline" "list_pull_requests" {
    pipeline = github.pipeline.list_pull_requests
    args = {
      repository_owner = "turbot"
      repository_name  = "flowpipe"
    }
  }
}

Run the pipeline:

flowpipe pipeline run my_pipeline

Developing

Clone:

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

List pipelines:

flowpipe pipeline list

Run a pipeline:

flowpipe pipeline run get_issue_by_number --arg 'issue_number=3997' --arg 'repository_owner=turbot' --arg 'repository_name=flowpipe'

To use a specific connection, specify the conn pipeline argument:

flowpipe pipeline run get_issue_by_number --arg 'issue_number=3997' --arg 'repository_owner=turbot' --arg 'repository_name=flowpipe' --arg conn=connection.github.github_profile

For more examples on how you can run pipelines, please see Run Pipelines.

Open Source & Contributing

This repository is published under the Apache 2.0 license. Please see our code of conduct. We look forward to collaborating with you!

Flowpipe is a product produced from this open source software, exclusively by Turbot HQ, Inc. It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our Open Source FAQ.

Get Involved

Join #flowpipe on Slack →

Want to help but not sure where to start? Pick up one of the help wanted issues: