GitHub Insights Mod
Create dashboards and reports for your GitHub repository resources using Steampipe.
Overview
Dashboards can help answer questions like:
- How many repositories do I have?
- How many branches do I have?
- What are the PRs in a repository?
- What are the branch protections rules in a repository?
References
GitHub is a provider of Internet hosting for software development and version control using Git. It offers the distributed version control and source code management (SCM) functionality of Git, plus its own features.
Steampipe is an open source CLI to instantly query cloud APIs using SQL.
Steampipe Mods are collections of named queries, codified controls that can be used to test current configuration of your cloud resources against a desired configuration, and dashboards that organize and display key pieces of information.
Documentation
Getting started
Installation
Download and install Steampipe (https://steampipe.io/downloads). Or use Brew:
brew tap turbot/tapbrew install steampipeInstall the GitHub plugin with Steampipe:
steampipe plugin install githubClone:
git clone https://github.com/turbot/steampipe-mod-github-insights.gitcd steampipe-mod-github-insightsUsage
Start your dashboard server to get started:
steampipe dashboardBy default, the dashboard interface will then be launched in a new browser window at http://localhost:9194. From here, you can view dashboards and reports.
Credentials
This mod uses the credentials configured in the Steampipe GitHub plugin.
Configuration
No extra configuration is required.
Contributing
If you have an idea for additional dashboards or just want to help maintain and extend this mod (or others) we would love you to join the community and start contributing.
- Join our Slack community → and hang out with other Mod developers.
Please see the contribution guidelines and our code of conduct. All contributions are subject to the Apache 2.0 open source license.
Want to help but not sure where to start? Pick up one of the help wanted issues: