Skip to content

Set up your GitHub Actions workflow with Flowpipe and credentials

License

Notifications You must be signed in to change notification settings

turbot/flowpipe-action-setup

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Setup Flowpipe for GitHub Actions

flowpipe-action status

This action installs Flowpipe and optionally configures Flowpipe credentials.

Usage

See action.yml.

Examples

Install the latest version Flowpipe

- name: Install Flowpipe
  uses: turbot/flowpipe-action-setup@v1

Install a specific version of Flowpipe

- name: Install Flowpipe v0.19.4
  uses: turbot/flowpipe-action-setup@v1
  with:
    flowpipe-version: 0.19.4

Configure multiple AWS credentials

- name: Setup Flowpipe
  uses: turbot/flowpipe-action-setup@v1
  with:
    flowpipe-config: |
      credential "aws" "aws_prod" {
        access_key = "${{ secrets.AWS_ACCESS_KEY }}"
        secret_key = "${{ secrets.AWS_SECRET_ACCESS_KEY }}"
      }

      credential "aws" "aws_dev" {
        access_key    = "${{ secrets.DEV_AWS_ACCESS_KEY }}"
        secret_key    = "${{ secrets.DEV_AWS_SECRET_ACCESS_KEY }}"
        session_token = "${{ secrets.DEV_AWS_SESSION_TOKEN }}"
      }

For further information on credentials refer to Managing Credentials or for available Flowpipe versions refer to Flowpipe Releases.

Run a Flowpipe Github Mod pipeline

steps:
  - uses: actions/checkout@v3
  - name: Setup Flowpipe
    uses: turbot/flowpipe-action-setup@main
    with:
      flowpipe-version: 'latest'
      flowpipe-config: |
        credential "github" "default" {
          token = "${{ secrets.GH_TOKEN }}"
        }
  - name: Install mod and run pipeline
    run: |
        mkdir pipelines
        cd pipelines
        flowpipe mod install github.com/turbot/flowpipe-mod-github
        flowpipe pipeline run github.pipeline.search_repositories --arg 'search_value=owner:turbot'

Pipeline that searches for GitHub repositories owned by 'turbot', extracting information such as creation date and popularity metrics.

Helpful Links