Skip to content
database

GitHub Action

GitHub GraphQL Action

2.0.1 Latest version

GitHub GraphQL Action

database

GitHub GraphQL Action

A client for GitHub GraphQL API

Installation

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

 
              
- name: GitHub GraphQL Action

              
  uses: helaili/github-graphql-action@2.0.1
Learn more about this action in helaili/github-graphql-action

Choose a version

github-graphql-action

An action that acts a client for GitHub's GraphQL API and can be chained. It means you can use a first instance to execute a GraphQL query and use its output to execute a GraphQL mutation.

Check a sample workflow and sample GraphqQL queries

Input parameters

Parameter   Description
query Query file path within the repo. Required
outputFile The name of the file, relative to GITHUB_WORKSPACE, where the output will be stored.
url GraphQL endpoint URL. Defaults to https://api.github.com/graphql
accept Accept header to set in the query. Optional
logLevel Enable logging. Values are info, timer, debug, warn, error. Optional

Output parameter

Parameter   Description
queryResult The outcome of the query

Query file

The query file contains the GraphQL query or mutation to execute. Format is YAML based.

Static parameters

query: '
  query($owner:String!, $name:String!) {
    repository(owner:$owner, name:$name) {
  	 name
   }
  }'
variables:
  owner: helaili
  name: github-graphql-action
...
jobs:
  static-query:
    runs-on: ubuntu-16.04
    steps:
    - uses: actions/checkout@v2
    - uses: ./
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        query: samples/repository-static.query.yaml

Parameters defined in the worklow

Variables values can also come from extra input parameters.

query: '
  query($owner:String!, $name:String!) {
    repository(owner:$owner, name:$name) {
  	 name
   }
  }'
variables:
  owner:
    type: arg
    name: owner
  name:
    type: arg
    name: name
...
jobs:
  args-query:
    runs-on: ubuntu-16.04
    steps:
    - uses: actions/checkout@v2
    - uses: ./
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        query: samples/repository-args.query.yaml
        owner: helaili
        name: github-graphql-action

File based parameters

Variable values can also come from a file, typically event.json which contains the event which triggered the action workflow (in ../workflow) or an arbitrary file (relative to /github/workspace) containing the result from a previous action (declared using the output command line parameter). This file is then processed by a jq query in order to extract the scalar value needed for the GraphQL query.

You can optionally add a cast parameter in order to convert the jq output to an Int, Float or Boolean

query:'
  query($owner:String!, $name:String!) {
    repository(owner:$owner, name:$name) {
      name
    }
  }'
variables:
  owner:
    type: jq
    file: ../workflow/event.json
    query: '.repository.owner.login'
  name:
    type: jq
    file: ../workflow/event.json
    query: '.repository.name'
...
jobs:
  introspection-query:
    runs-on: ubuntu-16.04
    steps:
    - uses: actions/checkout@v2
    - uses: ./
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        query: samples/introspection.query.yaml
        logLevel: debug
        accept: application/vnd.github.elektra-preview+json

Mutation

query: '
  mutation pinIssue($issueId: ID!){
    pinIssue(input: { issueId: $issueId }) {
      issue {
        repository {
          id
        }
      }
    }
  }'
variables:
  issueId:
    type: jq
    file: ../workflow/event.json
    query: '.issue.node_id'