GitXplorerGitXplorer
D

gatsby-source-github

public
18 stars
3 forks
4 issues

Commits

List of commits on branch master.
Verified
d100fd687d053ddddc188fb742aea163660d5e11

Update README.md

DDSchau committed 6 years ago
Verified
5d547ecce38de3f3554d272cda99ad67ed66865e

Update README.md

DDSchau committed 7 years ago
Verified
cf2702af796a86694712361e65a84c418cdef75b

Update README.md

DDSchau committed 7 years ago
Unverified
a86907ea603b1082c0eec8f1f95bd2196f1e5cc6

chore: fix issue

DDSchau committed 7 years ago
Unverified
7cf4ac27ba539fe7501fd64ea995b10412b42434

chore: prepare for non namespaced release

DDSchau committed 7 years ago
Verified
9bef7b5a4be0a415991642f3a32f137bafae32d9

Update README.md

DDSchau committed 7 years ago

README

The README file for this repository.

gatsby-source-github (DEPRECATED)

Build Status


Use gatsby-source-graphql to enable schema stitching with Github's API, rather than this source plugin.


Source plugin for pulling in Github data (using its GraphQL API) at buildtime for static generation and further GraphQL querying with Gatsby. Check out this repo for an example usage.

Install

npm install gatsby-source-github --save-dev

How to use

In your gatsby-config.js:

plugins: [
  {
    resolve: 'gatsby-source-github',
    options: {
      headers: {
        Authorization: `Bearer YOUR_GITHUB_PERSONAL_ACCESS_TOKEN`, // https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/
      },
      queries: [
        `{
          repository(owner: "nebraskajs", name: "speaker-signup") {
            issues(last: 20, states: OPEN) {
              edges {
                node {
                  id
                  author {
                    avatarUrl
                    login
                    url
                  }
                  bodyHTML
                  title
                  url
                }
              }
            }
          }
        }`,
      ],
    },
  },
];

queries is an array of GraphQL queries. The algorithm to generate Gatsby GraphQL nodes is described below

How to query

In general, use the Github API v4 documentation and in particular, the explorer to craft your queries and refer to the the below algorithm for how to query against these results with Gatsby.

Using variables

Additionally, variables can be used/injected into the queries. Rather than sending a string in the queries array, send an array like so:

[
  `query getViewer($first: Int!) {
    viewer {
      login
      name
      repositories(first:$first) {
        edges {
          node {
            name
          }
        }
      }
    }
  }`,
  { first: 10 },
];

The algorithm

The algorithm is quite simple. It'll descend through the tree/returned structure, and if it finds an edges key will use the parent of that as the node name. For instance, in the above repository example, githubIssue will be the node name, and allGithubIssues will be the way to query against all nodes. In the viewer example the node name will be githubViewer.

All fields in the node that are queried against in the Github GraphQL query are available to be queried with Gatsby. For example, in the repository example above, id, author (and subfields), bodyHTML, etc. are available to be queried against.