GitHub Action Server

Getting Started

A basic example:

name: Example Push Action
 
on: push
 
jobs:
  create_run:
    runs-on: ubuntu-latest
    name: Update Grai
    steps:
      - name: Checkout
        uses: actions/checkout@v2
 
      - name: Create Run
        uses: grai-io/grai-actions-server@master
        with:
          api-key: ${{ secrets.GRAI_API_KEY }}
          action: update
          connection_id: ${{ secrets.GRAI_DATABASE_CONNECTION_ID }}

See the three example pull requests here (opens in a new tab) for more examples.

Fields

Api Key

Set to a Grai Api Key. To generate an Api key, go to settings from the profile menu, followed by Api Keys and choose Add API Key.

Action

An optional value which must be either update or tests. Defaults to update.

Connection Id

Set to the UUID of an existing Connection. To find the connection id, navigate to connections and click on a connection, you can find the id at the top of the connection properties. Connection Id is optional, if you don't have an existing connection you can use the following fields instead.

Connection Name

Required if a connection id is not provided. Choose from the available connections.

Connection Namespace

You can supply a namespace for the connection, if no value is provided the field defaults to default.

Connection Metadata

Provide a JSON string representing the connection metadata. The required keys varies for each connection, see below.

Connection Secrets

Provide a JSON string representing the connection secrets. The required keys varies for each connection, see below.

Connection Metadata and Secrets

Google Bigquery

Microsoft SQL Server

MySQL

PostgreSQL

Snowflake

Fivetran

See https://fivetran.com/docs/rest-api/getting-started (opens in a new tab) to generate an api key.