Skip to content
message-circle

GitHub Action

Hasura Change Summary

v2.4.3 Latest version

Hasura Change Summary

message-circle

Hasura Change Summary

Generate readable Hasura metadata change summaries

Installation

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

              
- name: Hasura Change Summary

              
  uses: Fieldguide/action-hasura-change-summary@v2.4.3
Learn more about this action in Fieldguide/action-hasura-change-summary

Choose a version

ci

Hasura Change Summary

GitHub Action to generate readable Hasura metadata change summaries.

Hasura Change Summary example comment

Features

This action currently supports changes to database table metadata including row-level and column-level permissions.

Other metadata such as actions, cron triggers, and remote schemas are not currently supported.

Usage

For example, with marocchino's Sticky Pull Request Comment:

name: ci

on:
  pull_request:
    paths:
      - 'metadata/**.yaml'

jobs:
  hasura-change-summary:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Detect Hasura metadata changes
        uses: Fieldguide/action-hasura-change-summary@v2
        id: hasura-change-summary
        with:
          hasura_endpoint: https://my-pr-${{ github.event.number }}-app.example.com

      - name: Create or update summary comment
        uses: marocchino/sticky-pull-request-comment@v2
        if: steps.hasura-change-summary.outputs.change_html
        with:
          header: hasura-change-summary
          message: ${{ steps.hasura-change-summary.outputs.change_html }}

Inputs

input description
github_token Repository GITHUB_TOKEN or personal access token secret; defaults to github.token
project_dir Hasura project directory, relative to GITHUB_WORKSPACE; defaults to .
hasura_endpoint Hasura GraphQL engine http(s) endpoint, used for deep console links

Outputs

output description
change_html HTML change summary