https://github.com/turbot/flowpipe-action-setup
Set up your GitHub Actions workflow with Flowpipe and credentials
https://github.com/turbot/flowpipe-action-setup
flowpipe github-actions
Last synced: about 1 month ago
JSON representation
Set up your GitHub Actions workflow with Flowpipe and credentials
- Host: GitHub
- URL: https://github.com/turbot/flowpipe-action-setup
- Owner: turbot
- License: apache-2.0
- Created: 2024-01-08T21:09:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-06T03:31:43.000Z (about 2 years ago)
- Last Synced: 2025-02-21T12:18:19.171Z (over 1 year ago)
- Topics: flowpipe, github-actions
- Language: JavaScript
- Homepage: https://flowpipe.io
- Size: 298 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Setup Flowpipe for GitHub Actions
This action installs [Flowpipe](https://github.com/turbot/flowpipe/) and optionally configures Flowpipe credentials.
## Usage
See [action.yml](action.yml).
## Examples
### Install the latest version Flowpipe
```yaml
- name: Install Flowpipe
uses: turbot/flowpipe-action-setup@v1
```
### Install a specific version of Flowpipe
```yaml
- name: Install Flowpipe v0.19.4
uses: turbot/flowpipe-action-setup@v1
with:
flowpipe-version: 0.19.4
```
### Configure multiple AWS credentials
```yaml
- 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](https://flowpipe.io/docs/run/credentials) or for available Flowpipe versions refer to [Flowpipe Releases](https://github.com/turbot/flowpipe/releases).
### Run a Flowpipe Github Mod pipeline
```yaml
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
- [Flowpipe docs](https://flowpipe.io/docs)
- [Flowpipe mods](https://hub.flowpipe.io/)