Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

gatsby-source-circleci

LekoArts137MIT2.0.0TypeScript support: included

Source plugin for CircleCI's API.

circleci, circle-ci, gatsby-plugin, gatsby-source

readme

gatsby-source-circleci

Source plugin for CircleCI's API.

Please Note: This plugin was initially created to deliver data for my dashboard and hence only queries the user and projects. If you need more functionality, I'd be happy to review your PR and merge it into this plugin!

Install

npm install --save gatsby-source-circleci

How to use

Prerequisites

Go to Account dashboard and create a new API token.

Save the API key in an environment file like:

CIRCLECI_KEY=your-api-token-here

gatsby-config

Add the plugin and define the API key.

module.exports = {
  plugins: [
    {
      resolve: 'gatsby-source-circleci',
      options: {
        apiKey: process.env.CIRCLECI_KEY,
      }
    }
  ]
}

changelog

Changelog

2.0.0

  • Update circleci-api from v1 to v2
  • Add pluginOptionsSchema for options
  • Update dependencies
  • Added peerDep of >=3.0.0 for gatsby

1.0.0 - 1.0.3

Updated packages

1.0.0

Initial release