Introducing the GitHub CloudQuery Plugin

Ron Eliahu

Ron Eliahu

GitHub is a source-control provider that helps developers store and manage their code, as well as track and control changes to their code.
In this tutorial, we will install CloudQuery and use it to fetch GitHub resources. Then, we will use SQL to get visibility into security, compliance and cost-management in GitHub.

Setup #

  • read:org
  • Create a cloudquery.yml file, similar to the following:
    kind: source
      name: github
      path: cloudquery/github
      registry: cloudquery
      version: 'VERSION_SOURCE_GITHUB'
      tables: ['*']
      destinations: ['postgresql']
        access_token: <YOUR_ACCESS_TOKEN>
        orgs: ['cloudquery']
    kind: destination
      name: 'postgresql'
      path: cloudquery/postgresql
      registry: cloudquery
      write_mode: 'overwrite-delete-stale'
        connection_string: 'postgresql://postgres:pass@localhost:5432/postgres?sslmode=disable'
  • Run
    cloudquery sync cloudquery.yml

Use Cases #

After we finish fetching our config data we can make queries for security, compliance, cost management and other purposes.

Find all Public Repositories #

-- Query all repositories in the organizations that are public
SELECT id, org, name, description FROM github_repositories
WHERE private = false

Organization Billing #

-- Get billing information state for actions, packages and storage
SELECT * FROM github_billing_action

SELECT * FROM github_billing_package

SELECT * FROM github_billing_storage

Long Standing Open Issues #

-- Find all open issues that have been open for more than 7 days
SELECT,,, gi.state, gi.created_at, gi.updated_at
FROM github_issues gi
INNER JOIN github_repositories gr ON = (gi.repository->'id')::bigint
WHERE state = 'open' AND NOW() - interval '7 days' > gi.created_at

What's next #

We are going to continue expanding the GitHub Provider, adding support for more resources. Interested in seeing another plugin? Check out Developing New plugin and/or open an issue on our GitHub.
Subscribe to product updates

Be the first to know about new features.

© 2024 CloudQuery, Inc. All rights reserved.