Search

Welcome to Datagrid
Welcome to Datagrid
GitHub

GitHub

GitHub is a web-based platform used for version control, collaboration, and code management in software development. By connecting GitHub to Datagrid, you can seamlessly integrate your repository data with other business-critical information, enabling enhanced reporting, analysis, and decision-making.

1. How-to

1. Prerequisites

To configure the GitHub connector, follow these steps:

  • An active GitHub account with the necessary permissions to access the projects and data you want to import into Datagrid.
  • List of GitHub Repositories (and access for them in case they are private).
  • A GitHub Personal Access Token (PAT). You can generate this from your GitHub account settings under "Developer settings" -> "Personal access tokens".
  • Select the data you want to import into Datagrid

2. Connect

Creating a dataset from the GitHub connector involves selecting the specific data you want to import:

  1. Connect GitHub App: a. Click on the "+ Create” Button on the top left of the screen. b. Select the "Connect Apps" item. c. Search for the GitHub connector from the list. d. Login with your GitHub account. GitHub may prompt you to authorize Datagrid's access to your data. Grant the necessary permissions to proceed. e. Click on the “Next” button.
  2. Pick your Data: a. Pick the GitHub data you want to include in your dataset (e.g., Issues, Pull Requests, Commits). b. Click on the “Start First Import” Button to start syncing your GitHub dataset.

3. Set Up a Schedule:

Scheduling regular data pulls ensures your Datagrid datasets remain up-to-date with the latest information from GitHub:

  1. Navigate to GitHub Dataset: a. Go to the left side panel and locate and click on the GitHub dataset you created.
  2. Schedule Settings: a. Click on the “...” on the top right of the dataset. b. Click on “Edit Pipeline” to edit your connector's name. c. Click the “Schedule” button on the right, beside the “Import Configuration” button.
  3. Configure Schedule: a. Set the desired frequency for data pulls (e.g., daily, weekly, monthly). b. Specify the time of day for the data pull to occur. c. Specify downtime if needed – when the sync should not happen. d. Click the “Update” button to update the new configuration.

4. Data Access

  • Objects
    • Assignees
    • Branches
    • Collaborators
    • Issue labels
    • Organizations
    • Pull request commits
    • Tags
    • Teams
    • Users
    • Comments
    • Commits
    • Issues
    • Pull requests
    • Releases
    • Repositories

5. Use Cases

  • Project Management: Track project progress, monitor task assignments, and analyze team performance by importing GitHub Issues and Pull Requests into Datagrid.
  • Code Quality Analysis: Identify code quality issues, track code review metrics, and improve code maintainability by importing GitHub Commits and Code Review data into Datagrid.
  • Security Monitoring: Monitor security vulnerabilities, track security-related issues, and improve security posture by importing GitHub Security Alerts and Vulnerability data into Datagrid.
  • Community Engagement: Analyze community contributions, track community growth, and improve community engagement by importing GitHub Stargazers, Forks, and Contributors data into Datagrid.

6. FAQ

Q: What is GitHub? A: GitHub is a web-based platform used for version control, collaboration, and code management in software development.

Q: What type of data can I import from GitHub? A: You can import issues, pull requests, commits, and other repository data.

Q: How often can I schedule data pulls from GitHub? A: You can schedule data pulls daily, weekly, or monthly.

7. Support & Additional Resources