https://github.com/Fieldguide/action-hasura-change-summary

GitHub Action to generate readable Hasura metadata change summaries.
https://github.com/Fieldguide/action-hasura-change-summary

actions change diff github-actions hasura metadata summary

Last synced: about 2 months ago
JSON representation

GitHub Action to generate readable Hasura metadata change summaries.

• Host: GitHub
• URL: https://github.com/Fieldguide/action-hasura-change-summary
• Owner: Fieldguide
• License: mit
• Created: 2021-01-23T13:32:45.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-01-01T02:34:21.000Z (about 1 year ago)
• Last Synced: 2024-04-25T02:41:32.018Z (9 months ago)
• Topics: actions, change, diff, github-actions, hasura, metadata, summary
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/hasura-change-summary
• Size: 42.5 MB
• Stars: 44
• Watchers: 5
• Forks: 1
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![ci](https://github.com/Fieldguide/action-hasura-change-summary/actions/workflows/ci.yml/badge.svg)](https://github.com/Fieldguide/action-hasura-change-summary/actions/workflows/ci.yml)

# Hasura Change Summary

[GitHub Action](https://github.com/features/actions) to generate readable [Hasura](https://hasura.io/) metadata change summaries.



## Features

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

[Other metadata](https://hasura.io/docs/latest/graphql/core/migrations/reference/metadata-format/) such as actions, cron triggers, and remote schemas are not currently supported.

## Usage

For example, with marocchino's [Sticky Pull Request Comment](https://github.com/marocchino/sticky-pull-request-comment):

```yaml

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`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication) |

| `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 |