A GitHub Action to send queries to GitHub's GraphQL API

Minimal example

Name: Log latest release
on:
  push:
    branches:
      - master

jobs:
  logLatestRelease:
    runs-on: ubuntu-latest
    steps:
      - uses: octokit/[email protected]
        id: get_latest_release
        with:
          query: |
            query release($owner:String!,$repo:String!) {
              repository(owner:$owner,name:$repo) {
                releases(first:1) {
                  nodes {
                    name
                    createdAt
                    tagName
                    description
                  }
                }
              }
            }
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      - run: "echo latest release: ${{ steps.get_latest_release.outputs.data }}"

To access deep values of outputs.data, check out gr2m/get-json-paths-action.

To see additional debug logs, create a secret with the name: ACTIONS_STEP_DEBUG and value true.

octokit/graphql-action is using @octokit/graphql internally with some additions

1. Requests are authenticated using the GITHUB_TOKEN environment variable. It is required to prevent rate limiting, as all anonymous requsets from the same origin count against the same low rate.
2. The owner and repo parameters are preset to the repository that the action is run in.

The actions sets data output to the response data. Note that it is a string, you cannot access any keys of the response at this point. The action also sets headers (again, to a JSON string) and status.

MIT