https://github.com/kaonone/subgraph-status-action

Github Action for checking the subgraph status
https://github.com/kaonone/subgraph-status-action

Last synced: 3 months ago
JSON representation

Github Action for checking the subgraph status

• Host: GitHub
• URL: https://github.com/kaonone/subgraph-status-action
• Owner: kaonone
• License: mit
• Created: 2022-02-01T09:42:39.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-06T18:12:01.000Z (about 2 years ago)
• Last Synced: 2025-01-24T06:12:43.791Z (4 months ago)
• Language: TypeScript
• Size: 229 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# GitHub Status Action

Use this action for getting status of subgraph indexing.

## Action arguments

* `subgraph: string` – subgraph name for check. Required

* `version: "current" | "pending"` – subgraph version for check. Optional, default value is `"pending"`

* `fail_on_error: boolean` – fails your workflow if the subgraph has indexing errors. Optional, default value is `false`

## Basic usage

```yaml

jobs:

  check-subgraph:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

      - name: Get subgraph status

        id: check

        uses: akropolisio/subgraph-status-action@v1

        with:

          subgraph: userName/my-amazing-subgraph

          version: pending

          fail_on_error: false

      - name: Do something if subgraph failed

        if: ${{ fromJSON(steps.check.outputs.hasError) }}

        run: |

          echo 'Error code ${{ steps.check.outputs.errorCode }}'

          echo 'Message ${{ steps.check.outputs.message }}'

        env:

          ERROR_CODE: ${{ steps.check.outputs.errorCode }}

          ERROR_MESSAGE: ${{ steps.check.outputs.message }}

      - name: Do something if subgraph healthy

        if: ${{ !fromJSON(steps.check.outputs.hasError) }}

        run: |

          echo 'Chain head block ${{ steps.check.outputs.chainHeadBlock }}'

          echo 'Latest synced block ${{ steps.check.outputs.latestBlock }}'

        env:

          CHAIN_HEAD_BLOCK: ${{ steps.check.outputs.chainHeadBlock }}

          LATEST_BLOCK: ${{ steps.check.outputs.latestBlock }}

```

## Versioning (for contributors)

See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)