Skip to content
terminal

GitHub Action

GitHub Action for Hasura

v3.0 Latest version

GitHub Action for Hasura

terminal

GitHub Action for Hasura

Wraps the Hasura CLI to enable common commands

Installation

Copy and paste the following snippet into your .yml file.

              

- name: GitHub Action for Hasura

uses: tibotiber/[email protected]

Learn more about this action in tibotiber/hasura-action

Choose a version

GitHub Actions for Hasura

This Action for Hasura enables arbitrary actions with the hasura cli.

Inputs

  • args - Required. This is the arguments you want to use for the hasura cli.

Environment variables

  • HASURA_ENDPOINT - Required. The endpoint of the Hasura GraphQL engine.

  • HASURA_ADMIN_SECRET - Optional. The admin secret (if any) for the Hasura GraphQL engine.

  • HASURA_WORKDIR - Optional. The path from the root of your repository to the directory where the migrations folder can be found.

  • HASURA_ENGINE_VERSION - Optional. The version of the hasura cli you want to use. By default, it will match the version from your endpoint and fall back on stable if the version endpoint request fails.

Example

To apply migrations with the Hasura CLI:

name: Hasura migration
on:
  push:
    branches:
      - master
jobs:
  hasura_migration:
    name: Hasura migration
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repo
        uses: actions/checkout@v3
      - name: Apply hasura migrations
        uses: tibotiber/hasura-action@master # use a tagged version instead of master
        with:
          args: migrate apply --all-databases
        env:
          HASURA_ENDPOINT: ${{ secrets.HASURA_ENDPOINT }}
          HASURA_ADMIN_SECRET: ${{ secrets.HASURA_ADMIN_SECRET }}
          HASURA_WORKDIR: backend/hasura # replace this by your own path if needed
          HASURA_ENGINE_VERSION: v2.6.2 # replace this by the version you need, remove to use stable

License

The Dockerfile and associated scripts and documentation in this project are released under the MIT License.

This project was forked from GitHub Action for Firebase.