Skip to main content

GitHub

GitHub is a developer platform that allows developers to create, store, manage and share their code. It uses Git software, providing the distributed version control of Git plus access control, bug tracking, software feature requests, task management, continuous integration, and wikis for every project.

To learn how Jira entities map to SQL tables, consult the table mappings guide.

How to Setup

To connect to a GitHub data source you need to register the GitHub credentials. This requires:

  • the name of the credential (which you can choose)
  • Base URL
  • GitHub Personal Access Token

Base URL

Users of GitHub Enterprise have their own custom URL, such as https://github.your_domain.com, which isn't necessary for users of the GitHub cloud service.

GitHub Personal Access Token

Navigate to Profile → Settings → Developer Settings to view the screen displayed below.

Generate new token

Select Generate New Token (classic) and on the following page, assign a name to your token and select an expiry date:

GitHub PAT name

Finally, assign the following scopes:

  • repo
  • read:org
  • gist
  • read:user
  • user:email
  • read:project

as shown below: GitHub Token Scopes

More information regarding GitHub Personal Access Tokens can be found here.

Examples

Basic

List active artifacts
Query for the active segments within a particular repository, essential for monitoring and organizing artifacts in current projects and maintenance activities, allowing you to concentrate on active artifacts while excluding expired ones to enhance artifact management efficiency.

Sample usage:

/github/actions_artifact/error?repository_name=<repo_name>
List artifacts
Retrieve the artifacts linked to a given repository on GitHub to assist developers in comprehending or overseeing resources connected to the project.

Sample usage:

/github/actions_artifact?repository_name=<repo_name>
List runners with mac operating system
Query for the segments that are using a Mac operating system in a given repository to gain insights into the OS distribution in your project for troubleshooting and optimization purposes.

Sample usage:

/github/actions_repository_runner/apple/macos?repository_name=<repo_name>
List runners which are in use currently
Querying the specified repository can help identify which runners are currently in use, aiding in resource utilization understanding and real-time workflow run management.

Sample usage:

/github/actions_repository_runner/in_use?repository_name=<repo_name>
List runners
Query which runners are linked to a given repository in GitHub Actions to aid in maintaining and optimizing workflow performance effectively.

Sample usage:

/github/actions_repository_runner?repository_name=<repo_name>
List secrets
Query a specific repository in the GitHub Actions environment to discover its hidden aspects, which can be beneficial for evaluating the repository's security and integrity.

Sample usage:

/github/actions_repository_secret?repository_name=<repo_name>
List failure workflow runs
List failed workflow runs in a given repository to help with debugging and troubleshooting workflow issues.

Sample usage:

/github/actions_repository_workflow_run/failure?repository_name=<repo_name>
List manual workflow runs
Query the manually triggered workflow runs in a given repository to analyze performance and results, enabling the identification of potential issues or areas for improvement.

Sample usage:

/github/actions_repository_workflow_run/manuals?repository_name=<repo_name>
List workflow runs
Query the settings of a given repository to gain insights into workflow runs, allowing for evaluation of efficiency, issue identification, and informed decisions on optimization.

Sample usage:

/github/actions_repository_workflow_run?repository_name=<repo_name>
List audit events by a specific actor (user) in the last 30 days
Querying activity logs can help monitor a specific user's actions on a platform like Github over a recent timeframe, enabling the detection of anomalies and ensuring a safe environment within the organization.

Sample usage:

/github/audit_log/events_actor?organization_name=<org_name>
List branch protection override audit events on a specific date using a search phrase
Query audit events from a repository on a specific date, focusing on branch protection overrides, to help organizations monitor and assess security risks and policy violations on their GitHub repositories.

Sample usage:

/github/audit_log/events?organization_name=<org_name>
List repository creation and deletion audit events on a specific date
Query for repository creation and deletion events that occurred on a specific date within your organization to track changes and maintain a record of repository actions for audit or review purposes.

Sample usage:

/github/audit_log/repo_events?organization_name=<org_name>
List commit details for each branch
Query the details of each commit across various branches of a specific GitHub repository to monitor alterations, identify patterns, and assess the involvement of various contributors throughout time.

Sample usage:

/github/branch/commits?repository_name=<repo_name>
List branches
Query a given repository to identify the segments that symbolize distinct branches, along with their protection status and linked commit specifics, which proves valuable for grasping the organization and safety precautions of a project.

Sample usage:

/github/branch?repository_name=<repo_name>
List branch protection information for each protected branch
Query the protection rules set for each safeguarded branch in a specific GitHub repository to understand the restrictions and permissions defining the repository's integrity.

Sample usage:

/github/branch/protection?repository_name=<repo_name>
Get repositories that require signed commits for merging
Query branches in a given repository that have a policy requiring signed commits for merging to maintain code integrity and ensure only verified changes are merged.

Sample usage:

/github/branch_protection/repositories/signed_commits?repository_name=<repo_name>
Get a single branch protection rule by node id
Query the specific rules and restrictions enforced on a particular branch within a GitHub repository for insight into branch management, protection, and adherence to code review and collaboration standards.

Sample usage:

/github/branch_protection/rules
List branch protection rules which are not currently utilised
Query for the locations within a given repository where branch protection rules are not being applied, facilitating the identification of unused rules and the optimization of the repository's security settings.

Sample usage:

/github/branch_protection/rules/not_utilised?repository_name=<repo_name>
List code owners from rules
Query the ownership of various code sections in a specific repository to identify responsible parties, facilitating effective collaboration and issue resolution, exemplified by a CODEOWNERS file from the GitHub Docs repository.

Sample usage:

/github/code_owner/rules
Commits by a given author
Query contributions by a specific user to a GitHub repository, sorted by most recent, to track individual productivity or review a developer's change history.

Sample usage:

/github/commit/authors?repository_name=<repo_name>
Contributions by author
Query the segments with the highest activity by monitoring the frequency of contributions from individual authors in a specific GitHub repository, which aids in identifying the most active contributors in a project.

Sample usage:

/github/commit/contributions_by_author?repository_name=<repo_name>
Commits with most file changes
Query the commits that have made the most file changes in a particular GitHub repository to understand key modifications that indicate the project's evolution and maintenance patterns.

Sample usage:

/github/commit/files/most_changes?repository_name=<repo_name>
Commits that were not verified
List the segments in a given repository that contain unverified commits, which can assist in identifying and enhancing security by pinpointing potentially malicious or unauthorized alterations to the codebase.

Sample usage:

/github/commit/not_verified?repository_name=<repo_name>
Recent commits
Retrieve the most recent changes in a given GitHub repository to monitor its evolution and gain insights into the development process.

Sample usage:

/github/commit/recent?repository_name=<repo_name>
List repositories having the security file
List the repositories on GitHub that have a security file to better grasp the security protocols established in each repository for maintaining project integrity and preventing unauthorized access.

Sample usage:

/github/community_profile/repositories
Get details about ANY public gist (by id)
Query a given code snippet on Github using its unique ID to quickly grasp its content and context without the need to navigate the platform itself.

Sample usage:

/github/gist/details
Get file details about ANY public gist (by id)
Query the contents of a public 'gist' on GitHub using its unique ID to effectively analyze shared code snippets without visiting the GitHub site.

Sample usage:

/github/gist/file/details
List basic gitignore info
List the different types of gitignore files present in your GitHub repositories for a systematic exploration to gain insights into the various ignore rules used across projects, which can enhance code management practices.

Sample usage:

/github/gitignore/basic_info
View the source of the Go template
Query a given repository to reveal the specifics of the initial Go template on GitHub, enabling developers to comprehend the base of Go programming language templates and initiating potential modifications or enhancements.

Sample usage:

/github/gitignore/source
List comments for your issues
Query the dialogue related to your issues on GitHub to discover instances of comments, including details about the commenter, the comment's content, and its creation time.

Sample usage:

/github/issue_comment/list
List comments for a specific issue which match a certain body content
Query for comments within a GitHub repository issue that include a specified keyword to effectively manage and analyze issue discussions, particularly useful for locating references to specific topics or terms.

Sample usage:

/github/issue_comment/search?repository_name=<repo_name>
List comments for a specific issue
Querying a repository can provide valuable information about the discussion related to a particular issue, including contributor details, comments, and interaction timelines, aiding in understanding the issue's progress and resolution.

Sample usage:

/github/issue_comment/specific?repository_name=<repo_name>
Join with github_my_repository to find open issues in multiple repos that you own or contribute to
Retrieve the open issues in repositories you have ownership or contribution rights to, focusing on those associated with a specific project, assisting in workflow management and task prioritization by offering a comprehensive view of pending tasks.

Sample usage:

/github/issue/github_my_repository/open
List all issues with labels as a string array (instead of JSON objects)
Query a given repository to discover issues that have been marked with certain labels for the purpose of identifying trends and patterns in issue categorization, which can improve the efficiency of issue management and resolution.

Sample usage:

/github/issue/items/labels?repository_name=<repo_name>
List all open issues in a repository with a specific label
List a query that assists in pinpointing unresolved issues categorized with a particular label in a specified repository to aid in prioritizing bug resolutions and enhancing project management processes.

Sample usage:

/github/issue/repo/open/label?repository_name=<repo_name>
Report of the number issues in a repository by author
Query for the sections where certain authors are impacting the issue count of a specific project, facilitating the analysis of individual contributions and the recognition of significant contributors or troublesome sections depending on the number of issues created by each author.

Sample usage:

/github/issue/reports/author_number?repository_name=<repo_name>
List the issues in a repository
Query the status and assignment of issues within a given GitHub repository to improve project task management and responsibility allocation, aiding in monitoring task progress and pinpointing workflow bottlenecks.

Sample usage:

/github/issue/repositories?repository_name=<repo_name>
List the unassigned open issues in a repository
Query a specific repository to find open issues that have not been assigned yet, thereby ensuring all tasks are being addressed promptly.

Sample usage:

/github/issue/unassigned_open?repository_name=<repo_name>
List basic license info
Query the basic information about licensing in your GitHub repositories to ensure adherence to open source licensing requirements and grasp the permissions linked to various licenses.

Sample usage:

/github/license/basic_info
Count your repositories by license
Query the count of repositories based on their licenses to analyze the distribution of license usage across them.

Sample usage:

/github/license/repositories
View conditions for a specific license
Query GitHub to examine the detailed conditions and descriptions linked to a specific license, which is essential for comprehending the usage terms and limitations before incorporating it into a project.

Sample usage:

/github/license/view/conditions
View limitations for a specific license
Query the limitations linked to a particular software license, like 'gpl-3.0', enabling comprehension of the rules and regulations that control the utilization of the licensed software.

Sample usage:

/github/license/view_limitations
View permissions for a specific license
Query the individual permissions linked to a specific software license to gain insight into the extent and restrictions of the license before utilizing or sharing software according to its conditions.

Sample usage:

/github/license/view_permissions
Summarize your gists by language.
Query the programming languages used in your GitHub gists to analyze their distribution and discover your most frequent language choices for creating gists.

Sample usage:

/github/my_gist/language
List your gists
Retrieve all the gists created on GitHub to efficiently manage and monitor your shared code snippets.

Sample usage:

/github/my_gist
List your public gists
Query your GitHub account to identify which code snippets are publicly accessible, facilitating the review of your open-source contributions and safeguarding against unintentional sharing of private code.

Sample usage:

/github/my_gist/public
List your 10 oldest open issues
Retrieve your longest unresolved open issues to assist in prioritizing your workflow and effectively managing your project.

Sample usage:

/github/my_issue/oldest_open
List all of the open issues assigned to you
Query the GitHub platform to identify the open issues that are currently assigned to you, aiding in workload management and task prioritization.

Sample usage:

/github/my_issue/open/assigned_to_me
Show your permissions on the Organization
Retrieve your access level and permissions within a GitHub organization to gain insight into your authorized actions, including organization administration, managing pinned items, creating projects, repositories, or teams, and verifying your current membership status.

Sample usage:

/github/my_organization/documentation
Show all members for the GitHub Organizations to which you belong
Query to identify the GitHub organizations that you are a part of, providing visibility into your collaborative coding environments and affiliations, which can aid in managing and comprehending your involvement in different coding projects and teams.

Sample usage:

/github/my_organization/github/organizations/members
List organization hooks that are insecure
Query potentially insecure organization hooks by identifying specific settings like lack of SSL security, absence of a secret, or non-HTTPS URLs to pinpoint and address security vulnerabilities within your organization's GitHub configuration.

Sample usage:

/github/my_organization/hooks/insecure
Basic info for the GitHub Organizations to which you belong
Query for the areas of membership in different GitHub organizations to gain insights into your engagement and position within them, such as the quantity of private and public repositories, team memberships, and total members.

Sample usage:

/github/my_organization/organizations
Show Organization security settings
Query security settings within your organization to monitor member permissions and two-factor authentication requirements for proper protection of GitHub repositories and pages.

Sample usage:

/github/my_organization/settings/security
List all your repository collaborators with admin or maintainer permissions
List individuals with elevated access rights in repositories to bolster security measures by verifying the necessity of permissions granted.

Sample usage:

/github/my_repository/collaborators
List repository hooks that are insecure
Query for identifying the segments with insecure settings in your GitHub repository hooks to uncover possible security vulnerabilities within the hooks configuration of repositories.

Sample usage:

/github/my_repository/hooks/insecure
List of repositories that you or your organizations own or contribute to
Query the repositories owned or contributed to by you or your organizations to gain insight into your coding engagements and collaborations, which can be valuable for monitoring project involvement and assessing the reach of your contributions.

Sample usage:

/github/my_repository/ownership
List your public repositories
Query your GitHub repositories to identify which ones are publicly accessible, a helpful way to safeguard your private work while showcasing the projects you desire.

Sample usage:

/github/my_repository/public
Show repository stats
Query repository statistics on GitHub to analyze popularity and user engagement metrics, providing valuable insights into performance by examining aspects such as primary language, forks, stars, subscribers, watchers, and last update date.

Sample usage:

/github/my_repository/stats
List of your starred repositories
Retrieve a list of the repositories you have starred on Github for convenient access and review of your preferred projects, aiding in monitoring repositories of interest or those you plan to contribute to later on.

Sample usage:

/github/my_star/starred
Basic info
Query the components of your GitHub team, such as the member count and repositories, in order to understand the team's structure and activities for improved resource management and allocation.

Sample usage:

/github/my_team/basic_info
Get organization permission for each team
Query the permissions of each team within your organization on GitHub to assist in access control management and ensuring appropriate permissions alignment.

Sample usage:

/github/my_team/organization/permissions
Get parent team details for child teams
Query the hierarchical structure of a GitHub organization by identifying sub-teams that are under a parent team to gain insight into team dynamics and collaboration structures within the organization.

Sample usage:

/github/my_team/parent_details
List dependabot alerts
Query the status and ecosystem of dependency packages within a specific organization to identify potential security vulnerabilities or outdated dependencies in the codebase.

Sample usage:

/github/organization_dependabot_alert?organization_name=<org_name>
List open critical dependabot alerts
Query the locations of critical security threats in your organization's dependabot alerts to prioritize security issues requiring immediate attention.

Sample usage:

/github/organization_dependabot_alert/open/critical?organization_name=<org_name>
List open dependabot alerts
Query open alerts pertaining to software dependencies within a particular organization to pinpoint potential vulnerabilities or areas requiring updates, thereby enhancing security and efficacy.

Sample usage:

/github/organization_dependabot_alert/open?organization_name=<org_name>
List external identities of an organization
Querying external identities associated with a specific organization provides valuable insights by identifying roles and usernames, assisting in evaluating the organization's security and access management structure.

Sample usage:

/github/organization_external_identity/an?organization_name=<org_name>
Basic info for a GitHub Organization
Query details of a particular GitHub organization to analyze its structure, activity, verification status, team and member counts, as well as repository count for insightful information.

Sample usage:

/github/organization/github
List admin members with two factor authentication disabled
Query instances within your organization where administrative members have not activated two-factor authentication to improve security by addressing these vulnerabilities.

Sample usage:

/github/organization_member/admin/two_factor_disabled?organization_name=<org_name>
List organization members
Query the organization's members and their roles to determine if two-factor authentication is enabled, which can bolster security measures by ensuring all members have an added layer of protection.

Sample usage:

/github/organization_member?organization_name=<org_name>
List members of an organization
Query a specific organization to determine which members have two-factor authentication enabled, assisting organizations in enforcing security protocols to guarantee added protection for all members' accounts.

Sample usage:

/github/organization/members?organization_name=<org_name>
List comments for a specific pull request which match a certain body content
Query for comments in a project update that include a specific keyword to streamline discussions and gain insights on relevant topics or issues within your project.

Sample usage:

/github/pull_request_comment/find_by_content?repository_name=<repo_name>
List all comments for a specific pull request
Query for the meaningful insights that user comments on a specific pull request can offer, which helps in grasping user engagement and feedback on particular code alterations in a GitHub repository.

Sample usage:

/github/pull_request_comment?repository_name=<repo_name>
List comments for all open pull requests from a specific repository
Retrieve the comments on all open pull requests within a given project to delve into the ongoing modifications and gain insight into current issues, proposed solutions, and overall progress.

Sample usage:

/github/pull_request_comment/repositories/open?repository_name=<repo_name>
Join with github_my_repository to find open PRs in multiple repos
Query for open pull requests in different repositories within a project, helpful for project managers to monitor contributions and updates.

Sample usage:

/github/pull_request/join/github_my_repository/find_open_prs_multiple_repos
List the open PRs in a repository with a given label
Query a specific repository to identify open pull requests labeled as 'bug' to streamline bug-fixing efforts and project management.

Sample usage:

/github/pull_request/open_prs_by_label?repository_name=<repo_name>
List the open PRs in a repository assigned to a specific user
List all open pull requests in a specific repository that have been assigned to a particular user, which aids in monitoring and managing the workload of individual contributors in a project.

Sample usage:

/github/pull_request/open_prs_by_user?repository_name=<repo_name>
List the pull requests for a repository that have been closed in the last week
List the method for monitoring recent activity in a designated GitHub repository, beneficial for project managers aiming to monitor project progress through identifying closed pull requests in the past week.

Sample usage:

/github/pull_request/repositories/closed_last_week?repository_name=<repo_name>
List open pull requests in a repository
Query the specific project to identify the active discussions regarding code changes, facilitating project management and contributor understanding of ongoing development initiatives and proposed modifications.

Sample usage:

/github/pull_request/repositories?repository_name=<repo_name>
List open PRs in a repository with an array of associated labels
Query for open pull requests in a specific repository, along with their associated labels, which aids in work management and prioritization by providing insight into the context and importance of each pull request.

Sample usage:

/github/pull_request/repos/pulls?repository_name=<repo_name>
List reviews for a specific pull request which match a certain body content
Query for finding and addressing specific feedback within reviews of a particular pull request by pinpointing comments containing a specific keyword.

Sample usage:

/github/pull_request_review/items?repository_name=<repo_name>
List all reviews for a specific pull request
Query all feedback related to a specific project update, which is valuable for developers and project managers seeking insights into the team's opinions, issues, and recommendations regarding a code change or feature enhancement.

Sample usage:

/github/pull_request_review?repository_name=<repo_name>
List reviews for all open pull requests from a specific repository
Query the provided feedback for all active changes proposed in a specific project to gain insights into the suggested improvements or modifications by contributors during the development process.

Sample usage:

/github/pull_request_review/repos/pulls?repository_name=<repo_name>
List rate limit of rest apis
Query how many requests remain and what the maximum limit is for your REST APIs to prevent exceeding rate limits and maintain operational efficiency.

Sample usage:

/github/rate_limit/apis
List rate limit info for GraphQL
Query the usage and availability of your GraphQL rate limit on GitHub to effectively manage your API requests and prevent exceeding the limit, aiding in strategizing your application's interactions with GitHub's API for continuous service.

Sample usage:

/github/rate_limit_graphql/info
Download statistics per release
Query the popularity of various releases in a given repository by monitoring download counts to gain insights into user preferences and determine the most successful releases.

Sample usage:

/github/release/download/statistics?repository_name=<repo_name>
List releases
Retrieve the update timeline for a given repository on Github to monitor the project's evolution and stay informed about new releases and modifications.

Sample usage:

/github/release?repository_name=<repo_name>
Obtain a JSON array of admins for all your repositories
Retrieve the segments that help identify all administrators for a given set of GitHub repositories, which is crucial for efficiently managing access and permissions.

Sample usage:

/github/repository_collaborator/admins
List all contributors of a repository
Query the permissions of different users within a specific project to assist project managers in grasping the roles and access levels of contributors for efficient management of project resources and responsibilities.

Sample usage:

/github/repository_collaborator/contributors?repository_name=<repo_name>
List all outside collaborators on a repository
Query the permissions granted to external collaborators in a given repository to verify access suitability and uncover security vulnerabilities.

Sample usage:

/github/repository_collaborator/outside?repository_name=<repo_name>
List dependabot alerts
Query a given repository to ascertain the status and type of dependabot alerts in order to effectively manage and update dependencies.

Sample usage:

/github/repository_dependabot_alert?repository_name=<repo_name>
List open critical dependabot alerts
Retrieve critical alerts in a given repository's dependencies that are currently open, facilitating the swift identification of potential security risks within the project's ecosystem.

Sample usage:

/github/repository_dependabot_alert/open/critical?repository_name=<repo_name>
List open dependabot alerts
Query active dependency alerts within a specific GitHub repository to manage security and keep dependencies up-to-date in projects.

Sample usage:

/github/repository_dependabot_alert/open?repository_name=<repo_name>
List deployments for a repository
Query the deployment history of a given repository to analyze its version updates and changes contributed by various individuals, enabling monitoring of the project's development and evaluating its advancement throughout time.

Sample usage:

/github/repository_deployment/a?repository_name=<repo_name>
List deployments for all your repositories
Query deployment history data for all repositories on GitHub to analyze deployment details like creator, status, and environment, gaining insights into the deployment activities of repositories.

Sample usage:

/github/repository_deployment
List environments for a repository
Retrieve the environments linked to a given repository to gain insights into the various locations where your code is undergoing testing or deployment.

Sample usage:

/github/repository_environment/a?repository_name=<repo_name>
List environments all your repositories
List the segments that encompass all of the environments in a given repository to facilitate the identification and management of the environments where your code is executed, thus improving your project's efficiency and security.

Sample usage:

/github/repository_environment
Get your permissions for a specific repository
Query your access level to a specific repository to ascertain your ability to administer, create projects, subscribe, or update topics, ensuring you possess the appropriate permissions for your planned activities and minimizing the risk of encountering unexpected access problems.

Sample usage:

/github/repository/errors/400?repository_name=<repo_name>
Get information about a specific repository
Query a given repository to retrieve its creation date, update history, disk usage, owner, primary language, number of forks, star count, URL, license information, and description, which provides valuable insights into the repository's status, usage, and popularity.

Sample usage:

/github/repository/information
List SBOM packages with a specific package version
Query a specific GitHub repository to identify software bill of materials (SBOM) packages using a particular version, which is helpful for ensuring version consistency and addressing potential vulnerabilities linked to specific versions.

Sample usage:

/github/repository_sbom/packages?repository_name=<repo_name>
Find SBOMs created by a specific user or at a specific time
Query the software bill of materials (SBOMs) for a specific individual or date to track changes and better understand the history of software development.

Sample usage:

/github/repository_sbom/retrieve_created_by_user_and_time?repository_name=<repo_name>
Retrieve SBOMs under a specific data license
Query a specific repository to identify software bill of materials (SBOMs) licensed under a particular data license to aid in compliance assessment and intellectual property management.

Sample usage:

/github/repository_sbom/retrieve?repository_name=<repo_name>
Find SBOMs conforming to a specific SPDX version
Query settings to identify Software Bill of Materials (SBOMs) that correspond to a particular SPDX version in a specified repository to ensure adherence and alignment with relevant standards.

Sample usage:

/github/repository_sbom/spdx_versions?repository_name=<repo_name>
List vulnerability alerts
Querying a specific repository allows for analysis of its security vulnerabilities, offering details on severity and descriptions to facilitate prioritization and resolution of security issues.

Sample usage:

/github/repository_vulnerability_alert?repository_name=<repo_name>
List open vulnerability alerts
Querying can help detect active vulnerability alerts within a specific GitHub repository, aiding in swiftly addressing potential threats to maintain repository security.

Sample usage:

/github/repository_vulnerability_alert/open?repository_name=<repo_name>
List open critical vulnerability alerts
Query a given repository to identify any open critical security vulnerabilities, aiding in prioritizing security efforts by focusing on resolving the most severe issues initially.

Sample usage:

/github/repository_vulnerability_alert/retrieve/critical/open?repository_name=<repo_name>
List searched codes by file location
Query for codes that have been searched based on their file location on GitHub to gain insights into areas of interest or common search behaviors within specific directories.

Sample usage:

/github/search_code/file_location
List searched codes while file size is greater than 40 KB
Query for files larger than 40KB and written in Markdown within a specific organization on GitHub to identify and potentially optimize or split up bloated files.

Sample usage:

/github/search_code/files/40kb
List searched codes by extension
Query for the most frequently searched codes by their file extension to analyze popular coding practices and enhance project organization based on code usage trends in your GitHub projects.

Sample usage:

/github/search_code/files/extension
List searched codes by the file contents or file path
Query the segments that have been searched in a given repository on GitHub by either file contents or file path, offering advantages in identifying specific code locations and gaining understanding of code usage and organization.

Sample usage:

/github/search_code/files
List searched codes by language
Query the languages that codes have been searched for on GitHub, which provides insights into the popularity and usage of various programming languages within a specific organization.

Sample usage:

/github/search_code/languages
List searched codes within organization's repositories
Query the repositories in your organization to determine which codes have been searched, providing insights into the areas of interest and focus within your team's coding projects.

Sample usage:

/github/search_code/organizations/repos
List repository details
List through this query to delve into and grasp the specifics of individual repositories within your organization on GitHub, assisting in pinpointing and evaluating the repositories that house a particular file to streamline file management and organization effectively.

Sample usage:

/github/search_code/repositories
List text match details
Querying GitHub code search can reveal text matches to pinpoint occurrences of specific text like filenames or properties within an organization's codebase.

Sample usage:

/github/search_code/text_match_details
List searched codes within a user's repositories
Query the searched codes in a user's repositories to gain insights into the areas of the codebase receiving attention and potentially influencing future development decisions.

Sample usage:

/github/search_code/user/repositories
List searched codes within a user's specific repository
Query codes that have been searched within a specific user's repository to identify popular topics or areas of interest within a particular project.

Sample usage:

/github/search_code/users/repository
List searched commits by author
Query commits made by a specific author in a designated GitHub repository to gain insights into the author's contribution history and influence on the project.

Sample usage:

/github/search_commit/authors
List searched commits committed within the specified date range
Query commits made within a specified date range in a particular repository to track project progress or review changes during a specific period.

Sample usage:

/github/search_commit/date_range
List searched commits by hash
Retrieve the specific commits in a given repository on GitHub by searching for a particular hash to track changes and comprehend the project's history.

Sample usage:

/github/search_commit/hash
List searched commits by parent
Query commits on GitHub that have a specific parent commit to analyze the progression of code changes, track project evolution, and determine the effects of individual commits.

Sample usage:

/github/search_commit/items_by_parent
List searched commits by merge commits
Query the merged commits in a given repository to comprehend the alterations within it and monitor the project's advancement.

Sample usage:

/github/search_commit/list/merge
List searched commits within organization's repositories
Query to track particular changes or additions in organization repositories, like pinpointing when a specific table was added, enabling monitoring and reviewing of the codebase evolution to improve oversight and control over the development process.

Sample usage:

/github/search_commit/organizations/repositories
List repository details
Query repository details such as name, ID, and owner with this helpful query, enabling easy access to key information without the need for manual navigation on GitHub.

Sample usage:

/github/search_commit/repositories
List searched commits within a user's specific repository
Query changes made within a user's repository to track project development and modifications effectively.

Sample usage:

/github/search_commit/users/repositories
List blocked issues
Query instances where issues are blocked in a given repository to understand project bottlenecks and prioritize tasks effectively.

Sample usage:

/github/search_issue/blocked
List issues with over 10 comments
List instances where GitHub issues in a given organization have received more than 10 comments, beneficial for monitoring active discussions and identifying topics with high community engagement.

Sample usage:

/github/search_issue/comments/top
List issues with public visibility assigned to a specific user
Query for segments containing public issues assigned to a specified user on GitHub for the purpose of monitoring a developer's work or tracking public issues within a specific repository.

Sample usage:

/github/search_issue/items/public/assigned/user
List issues that took more than 30 days to close
Query segments within a particular organization that required over a month for resolution to analyze issue resolution efficiency and identify potential areas for workflow enhancement.

Sample usage:

/github/search_issue/more_than_30_days
List issues in open state assigned to a specific user
Query a given repository to identify open issues assigned to a specific user, which can aid in monitoring the workload of that user or tracking the progress of issue resolution.

Sample usage:

/github/search_issue/open/assigned_to
List issues not linked to a pull request
Query the GitHub repository for the Steampipe plugin to find areas with active issues not linked to any pull request in order to identify tasks requiring attention or further investigation.

Sample usage:

/github/search_issue/pages
List issues by the title, body, or comments
List segments that contain issues by analyzing their title, body, or comments, which can enhance comprehension and efficient issue management.

Sample usage:

/github/search_issue/title_body_comments
List labels for bug, enhancement and blocked
Query a given repository to identify the usage of specific labels like 'bug', 'enhancement', and 'blocked' to gain insights into issue categorization and priority assignment.

Sample usage:

/github/search_label/bug/enhancement/blocked
List labels where specific text matches in name or description
Query a given repository to find areas where specific text matches in labels' name or description, facilitating the quick identification and categorization of labels pertaining to certain topics or tasks.

Sample usage:

/github/search_label/search
List pull requests that took more than 30 days to close
Query for the specific areas where pull requests have exceeded a one-month closure time to pinpoint bottlenecks in the code review process and gain insights for enhancing efficiency.

Sample usage:

/github/search_pull_request/closed_deals/more_than_30_days
List pull requests with over 50 comments
Query the GitHub repositories to identify pull requests with over 50 comments to uncover areas where significant discussion has been sparked, shedding light on contentious or complex issues within the organization.

Sample usage:

/github/search_pull_request/comments/over50
List open draft pull requests
List the draft pull requests in a GitHub organization to identify incomplete tasks and prioritize work for the development team.

Sample usage:

/github/search_pull_request/drafts/open
List pull requests not linked to an issue
Query for instances where open pull requests are not associated with an issue in a specific repository to improve issue tracking and documentation of code changes.

Sample usage:

/github/search_pull_request/issues
List pull requests in open state assigned to a specific user
Query the open pull requests assigned to a specific user in a given repository to track their individual contributions and progress in a collaborative environment.

Sample usage:

/github/search_pull_request/open/assigned/user
List pull requests by the title, body, or comments
Query GitHub pull requests to identify discussions or changes relevant to specific topics or keywords based on criteria in the title, body, or comments.

Sample usage:

/github/search_pull_request/title_body_comments
List pull requests with public visibility assigned to a specific user
List the public visibility pull requests assigned to a particular user in a GitHub repository to monitor their participation and contributions to public projects effectively.

Sample usage:

/github/search_pull_request/users/public/assigned
List repositories based on contents of a repository
Query repositories that are popular among users by analyzing the content of a specific repository to gain insights into user preferences and trends in the open-source community.

Sample usage:

/github/search_repository/contents
List repositories with more than 100000 followers
Query for the categories where high-performing repositories on GitHub have gained a significant following to uncover trends and patterns among the most popular repositories, providing valuable insights into the factors contributing to a repository's popularity.

Sample usage:

/github/search_repository/followers/more_than_100000
List forked repositories created within specific timestamp
Query for segments that have forked a given repository within a specified time frame, which can provide insights into the project's popularity and outreach during that period.

Sample usage:

/github/search_repository/forks/timestamp
Get a specific repository
Querying details about a repository, like the owner, programming language, and user engagement metrics can provide insights into its popularity and impact on the GitHub platform.

Sample usage:

/github/search_repository/specific
List topics that were created after a specific timestamp
Query the segments that have been created post a specified date, particularly within the realm of react-redux, which is valuable for monitoring the progression and expansion of react-redux related subjects over time.

Sample usage:

/github/search_topic/created_after
List featured topics
Query the highlighted topics on a given repository for the Steampipe GitHub plugin to gain insight into the emphasized or promoted areas of the plugin.

Sample usage:

/github/search_topic/featured
List topics that are not curated
Query a given repository to find topics that have not been curated, aiding in the upkeep of content quality and relevance by highlighting areas requiring additional focus.

Sample usage:

/github/search_topic/not_curated
List topics that have more than 5000 repositories
List the areas where popular topics on GitHub have more than 5000 repositories to identify prevalent subjects and highlight busy areas for potential collaboration or learning.

Sample usage:

/github/search_topic/repositories/more_than_5000
List users
Query GitHub instances where users have 'raw-labs' in their name to locate relevant user profiles for deeper analysis or communication purposes.

Sample usage:

/github/search_user
List users and organizations created between specific timestamp
Query the segments that have been newly added to your user base on GitHub within a defined timeframe to evaluate growth and track platform activity.

Sample usage:

/github/search_user/organizations
Get user with specific username
Querying to discover the GitHub user associated with a given username provides access to comprehensive details like their distinct ID, login type, and URL.

Sample usage:

/github/search_user/users/username
List stargazers with their contact information
Query a given repository to identify users who have starred it and gather their contact information to discover the segments that are actively showing interest, aiding in understanding the user base, facilitating community engagement, or reaching out for feedback.

Sample usage:

/github/stargazer/contact_information?repository_name=<repo_name>
New stargazers by month
List the monthly count of new stargazers for a given project on Github to analyze its popularity trend, aiding in assessing the project's growth and monitoring community engagement over time.

Sample usage:

/github/stargazer/new/month?repository_name=<repo_name>
List the stargazers of a repository
Query the users who have starred a specific GitHub repository and the timestamps of when they did so to gain insights into the repository's popularity and engagement.

Sample usage:

/github/stargazer/repositories?repository_name=<repo_name>
Get commit details for each tag
Query the details of each commit associated with various tags in a GitHub repository for purposes such as monitoring changes, identifying authors, and ensuring the accuracy of commits, all of which are essential for code review and version control.

Sample usage:

/github/tag/commits?repository_name=<repo_name>
List tags
Query GitHub for tagged versions of a given repository to track the project's evolution and identify versions for troubleshooting or reference purposes.

Sample usage:

/github/tag?repository_name=<repo_name>
Order tags by semantic version
Retrieve the most relevant segments within a given repository by sorting tags based on their semantic version, aiding in comprehension of the project's evolution and advancement.

Sample usage:

/github/tag/order_by_semantic_version?repository_name=<repo_name>
List team members for a specific team
Query team membership within a specific team in your organization to gain insights into team composition and roles.

Sample usage:

/github/team_member?organization_name=<org_name>&slug=<slug_name>
List team members with maintainer role for visible teams
Query the segments containing team members with a maintainer role in visible teams to analyze role distribution in your organization and identify individuals authorized to manage team settings.

Sample usage:

/github/team_member/roles/maintainer/visible
List active team members with maintainer role for a specific team
Query to identify active team members with the 'Maintainer' role in a specific team within an organization, aiding in team role management and ensuring each team has an active maintainer.

Sample usage:

/github/team_member/users/active/maintainer/roles/specific?organization_name=<org_name>&slug=<slug_name>
List all visible teams in an organization
Retrieve the teams that are publicly visible within a specific organization on GitHub to gain insights into the organization's team structure and privacy settings.

Sample usage:

/github/team/organizations/visible?organization_name=<org_name>
Get parent team details for child teams
Query the hierarchical relationships among your organization's teams on Github to gain insights into team structures and identify sub-teams within larger parent teams.

Sample usage:

/github/team/parent_details?organization_name=<org_name>
List teams with pending user invitations
Query teams with pending invitations to users in order to streamline onboarding procedures and prioritize necessary follow-ups.

Sample usage:

/github/team/pending_invitations?organization_name=<org_name>
Get the number of repositories for a single team
Query the total number of repositories linked to a particular team in your organization, which can provide insights into the team's workload and resource allocation within the organization.

Sample usage:

/github/team/repositories_number?organization_name=<org_name>
List a specific team's repositories
Querying a specific team's repositories within your organization on GitHub can provide insights into repository permissions, primary language, fork count, stargazer count, license information, and other pertinent details to aid in managing team resources and identifying areas for improvement.

Sample usage:

/github/team_repository/specifics?organization_name=<org_name>&slug=<slug_name>
List visible teams and repositories they have admin permissions to
Retrieve a list of teams and their respective repositories in your organization with administrative permissions to manage access rights and security in your GitHub organization.

Sample usage:

/github/team_repository/visible/admin?organization_name=<org_name>&slug=<slug_name>
Get the number of members for a single team
Query the number of members in a particular team within your organization on Github, which can aid in assigning resources and comprehending team interactions.

Sample usage:

/github/team/single/number_of_members?organization_name=<org_name>
List all visible teams
Query your GitHub account to identify the teams present, along with their respective privacy settings and descriptions, for effective collaboration management and insight into team dynamics.

Sample usage:

/github/team/visible?organization_name=<org_name>
List view statistics
Query the daily traffic statistics of a given repository to evaluate its popularity and number of distinct visitors, aiding in your understanding of the project's outreach and influence across different periods.

Sample usage:

/github/traffic_view_daily/statistics?repository_name=<repo_name>
List view statistics
Query the popularity and unique visitor count trend for a particular repository on Github to gain insights into its visibility and influence for guiding upcoming development and marketing plans.

Sample usage:

/github/traffic_view_weekly/statistics?repository_name=<repo_name>
List executable files
List all executable files within a specified repository to understand its structure and content, as well as identifying potential security risks linked to executable files.

Sample usage:

/github/tree/files/executable?repository_name=<repo_name>
List tree entries non-recursively
Query the elements within a given repository by identifying specific locations using a unique identifier to facilitate a non-recursive view of the repository's structure, making it easier to navigate and comprehend the layout and content of the repository.

Sample usage:

/github/tree/items?repository_name=<repo_name>
List JSON files
Querying a given repository can help developers or project managers quickly locate and manage all JSON files within it, aiding in tasks like code review, debugging, or configuration management.

Sample usage:

/github/tree?repository_name=<repo_name>
List tree entries for a subtree recursively
Query a specific subtree within a given repository to explore its components and gain insights into its recursive structure and elements.

Sample usage:

/github/tree/subtree_entries?repository_name=<repo_name>
Get information for a user
Query a particular GitHub user to analyze their activity and profile, which can provide valuable insights into contributions and user conduct.

Sample usage:

/github/user/information
List users that are members of multiple organizations
List users who are members of multiple organizations.

Sample usage:

/github/user/organizations/multiple_members
List workflows
Query a given repository to examine the traits and specifics of workflows, facilitating comprehension of the workflow layout and identifying distinct patterns or irregularities to assist in repository administration.

Sample usage:

/github/workflow?repository_name=<repo_name>

Combined

Linking GitHub Pull Requests to Jira Issues by title key
Retrieve a list of GitHub pull requests linked to Jira issues by matching the Jira issue key found in the pull request title.

Sample Usage:

To use this feature, format your request as follows:

/github_jira/basic[?repository=<repository_name>&days=<number_of_days>]
  • repository: The GitHub repository in the format <owner>/<repository_name>.
  • days: (Optional) The maximum age (in days) since a Jira issue was created. Defaults to 30 days.

Example:

If your GitHub organization is named my_org and your repository is called my_repo, your request should look like this:

/github_jira/basic?repository=my_org/my_repo

To specify a custom duration, for instance, to retrieve Jira issues created in the last 45 days, append the days parameter like so:

/github_jira/basic?repository=my_org/my_repo&days=45

This configuration fetches data from the specified GitHub repository and filters Jira issues based on the provided days parameter.

Merged GitHub pull requests with Jira issues correlation
Retrieve closed Jira issues correlated with merged GitHub pull requests

Sample Usage:

To use this feature, format your request as follows:

/github_jira/basic_release[?repository=<repository_name>&days=<number_of_days>]
  • repository: The GitHub repository in the format <owner>/<repository_name>.
  • days: (Optional) The maximum age (in days) since a Jira issue was created. Defaults to 30 days.

Example:

If your GitHub organization is named my_org and your repository is called my_repo, your request should look like this:

/github_jira/basic_release?repository=my_org/my_repo

To specify a custom duration, for instance, to retrieve Jira issues created in the last 45 days, append the days parameter like so:

/github_jira/basic_release?repository=my_org/my_repo&days=45

This configuration fetches data from the specified GitHub repository and filters Jira issues based on the provided days parameter.

Development bottlenecks identification via PR merge times and Jira Issue Status analysis
Analyze the time from creation to merge of pull requests and its correlation with the status of associated Jira issues to identify review bottlenecks or complexity in issue implementation.

Sample Usage:

To use this feature, format your request as follows:

/github_jira/basic_release[?repository=<repository_name>&days=<number_of_days>]
  • repository: The GitHub repository in the format <owner>/<repository_name>.
  • days: (Optional) The maximum age (in days) since a Jira issue was created. Defaults to 30 days.

Example:

If your GitHub organization is named my_org and your repository is called my_repo, your request should look like this:

/github_jira/basic_release?repository=my_org/my_repo

To specify a custom duration, for instance, to retrieve Jira issues created in the last 45 days, append the days parameter like so:

/github_jira/basic_release?repository=my_org/my_repo&days=45

This configuration fetches data from the specified GitHub repository and filters Jira issues based on the provided days parameter.

Correlation Between Closed Jira Issues and Merged GitHub Pull Requests Within a Given Release
Retrieve closed Jira issues linked to merged GitHub pull requests, for a given release

Sample Usage:

To use this feature, format your request as follows:

/github_jira/release[?repository=<repository_name>&days=<number_of_days>&version=<release_version>]
  • repository: The GitHub repository in the format <owner>/<repository_name>.
  • version: The GitHub release version number, e.g. 1.11.111
  • days: (Optional) The maximum age (in days) since a Jira issue was created. Defaults to 30 days.

Example:

If your GitHub organization is named my_org and your repository is called my_repo, and your release version number is 1.11.111, your request should look like this:

/github_jira/release?repository=my_org/my_repo&version=1.11.111

To specify a custom duration, for instance, to retrieve Jira issues created in the last 45 days, append the days parameter like so:

/github_jira/release?repository=my_org/my_repo&version=1.11.111&days=45

This configuration fetches data from the specified GitHub repository and filters Jira issues based on the provided days parameter.

Listing of Jira issues linked to GitHub pull requests that do not belong to any release
Retrieve Jira issues linked to GitHub pull requests that do not belong to any release

Sample Usage:

To use this feature, format your request as follows:

/github_jira/unreleased[?repository=<repository_name>&days=<number_of_days>]
  • repository: The GitHub repository in the format <owner>/<repository_name>.
  • days: (Optional) The maximum age (in days) since a Jira issue was created. Defaults to 30 days.

Example:

If your GitHub organization is named my_org and your repository is called my_repo, your request should look like this:

/github_jira/unreleased?repository=my_org/my_repo

To specify a custom duration, for instance, to retrieve Jira issues created in the last 45 days, append the days parameter like so:

/github_jira/unreleased?repository=my_org/my_repo&days=45

This configuration fetches data from the specified GitHub repository and filters Jira issues based on the provided days parameter.

Table Mappings

Once the GitHub credential is registered, a new schema will be available for query within RAW. The name of this schema matches the name of the "RAW credential" you chose above.

Within this schema, you will find a set of tables, which contain the information stored in Jira. These tables are:

Table NameDescription
github_actions_artifactActions Artifact
github_actions_repository_runnerActions Repository Runner
github_actions_repository_secretActions Repository Secret
github_actions_repository_workflow_runActions Repository Workflow Run
github_audit_logAudit Log
github_branchBranch
github_branch_protectionBranch Protection
github_code_ownerCode Owner
github_commitCommit
github_community_profileCommunity Profile
github_gistGist
github_gitignoreGitignore
github_issueIssue
github_issue_commentIssue Comment
github_licenseLicense
github_my_gistMy Gist
github_my_issueMy Issue
github_my_organizationMy Organization
github_my_repositoryMy Repository
github_my_starMy Star
github_my_teamMy Team
github_organizationOrganization
github_organization_dependabot_alertOrganization Dependabot Alert
github_organization_external_identityOrganization External Identity
github_organization_memberOrganization Member
github_pull_requestPull Request
github_pull_request_commentPull Request Comment
github_pull_request_reviewPull Request Review
github_rate_limitRate Limit
github_rate_limit_graphqlRate Limit Graphql
github_releaseRelease
github_repositoryRepository
github_repository_collaboratorRepository Collaborator
github_repository_dependabot_alertRepository Dependabot Alert
github_repository_deploymentRepository Deployment
github_repository_environmentRepository Environment
github_repository_sbomRepository Sbom
github_repository_vulnerability_alertRepository Vulnerability Alert
github_search_codeSearch Code
github_search_commitSearch Commit
github_search_issueSearch Issue
github_search_labelSearch Label
github_search_pull_requestSearch Pull Request
github_search_repositorySearch Repository
github_search_topicSearch Topic
github_search_userSearch User
github_stargazerStargazer
github_tagTag
github_teamTeam
github_team_memberTeam Member
github_team_repositoryTeam Repository
github_traffic_view_dailyTraffic View Daily
github_traffic_view_weeklyTraffic View Weekly
github_treeTree
github_userUser
github_workflowWorkflow

Actions Artifact

The table github_actions_artifact offers valuable information on artifacts created by GitHub Actions workflows. If you're a software developer or a DevOps engineer, you can delve into artifact-specific information within this table, like metadata and download links. This resource helps you discover details about artifacts, such as their size, download paths, and which workflow runs they are linked to.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
archive_download_urltextArchive download URL for the artifact.
created_attimestamp with time zoneTime when the artifact was created.
expiredbooleanIt defines whether the artifact is expires or not.
expires_attimestamp with time zoneTime when the artifact expires.
idbigintUnique ID of the artifact.
nametextThe name of the artifact.
node_idtextNode where GitHub stores this data internally.
repository_full_namerequiredtextFull name of the repository that contains the artifact.
size_in_bytesbigintSize of the artifact in bytes.

Actions Repository Runner

The github_actions_repository_runner table offers information on the self-hosted runners of GitHub Actions linked to a particular repository. In your role as a DevOps engineer, you can examine specific details about the runners using this table, such as their IDs, names, operating systems, statuses, and related metadata. Make use of this table to supervise and oversee your self-hosted runners, confirming that they are operating correctly and are kept current.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
busybooleanIndicates whether the runner is currently in use or not.
idbigintThe unique identifier of the runner.
labelsjsonbLabels represents a collection of labels attached to each runner.
nametextThe name of the runner.
ostextThe operating system of the runner.
repository_full_namerequiredtextFull name of the repository that contains the runners.
statustextThe status of the runner.

Actions Repository Secret

The table github_actions_repository_secret offers information about secrets saved in a GitHub repository. As a security engineer, analyze specific details related to these secrets using the table, such as their names and the dates they were created or modified. This resource can help you discover insights into the repository's secrets, identifying any that are no longer needed or outdated for a holistic understanding of the repository's security practices.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
created_attimestamp with time zoneTime when the secret was created.
nametextThe name of the secret.
repository_full_namerequiredtextFull name of the repository that contains the secrets.
selected_repositories_urltextThe GitHub URL of the repository.
updated_attimestamp with time zoneTime when the secret was updated.
visibilitytextThe visibility of the secret.

Actions Repository Workflow Run

The table for github_actions_repository_workflow_run offers valuable information about GitHub Actions Repository Workflow Runs. For software developers and DevOps engineers, this table allows you to examine specific details of each workflow run within a repository, such as its status, conclusion, and additional metadata. This tool can be used to closely track and evaluate the outcomes and efficiency of your CI/CD workflows, aiding in maintaining an effective and productive software development process.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
actorjsonbThe user whom initiated the first instance of this workflow run.
actor_logintextThe login of the user whom initiated the first instance of the workflow run.
artifacts_urltextThe address for artifact GitHub web page.
cancel_urltextThe address for workflow run cancel GitHub web page.
check_suite_urltextThe address for the workflow check suite GitHub web page.
conclusiontextThe conclusion for workflow run.
created_attimestamp with time zoneTime when the workflow run was created.
eventtextThe event for which workflow triggered off.
head_branchtextThe head branch of the workflow run branch.
head_commitjsonbThe head commit details for workflow run.
head_repositoryjsonbThe head repository info for the workflow run.
head_shatextThe head sha of the workflow run.
html_urltextThe address for the organization's GitHub web page.
idbigintThe unque identifier of the workflow run.
jobs_urltextThe address for the workflow job GitHub web page.
logs_urltextThe address for the workflow logs GitHub web page.
node_idtextThe node id of the worflow run.
pull_requestsjsonbThe pull request details for the workflow run.
repositoryjsonbThe repository info for the workflow run.
repository_full_namerequiredtextFull name of the repository that specifies the workflow run.
rerun_urltextThe address for workflow rerun GitHub web page.
run_numberbigintThe number of time workflow has run.
run_started_attimestamp with time zoneTime when the workflow run was started.
statustextThe status of the worflow run.
triggering_actorjsonbThe user whom initiated the latest instance of this workflow run.
triggering_actor_logintextThe login of the user whom initiated the latest instance of this workflow run.
updated_attimestamp with time zoneTime when the workflow run was updated.
urltextThe address for the workflow run GitHub web page.
workflow_idtextThe workflow id of the worflow run.
workflow_urltextThe address for workflow GitHub web page.

Audit Log

The github_audit_log table offers valuable information on user activity on GitHub. As a Security Analyst, you can use this table to investigate individual user actions, such as what actions were taken, the repositories involved, and when the actions occurred. This information can be utilized to discover details about user activities like changes to repositories, adjustments in team memberships, and any security threats that may arise.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
actiontextThe action performed.
actortextThe GitHub user who performed the action.
actor_locationjsonbThe actor's location at the moment of the action.
created_attimestamp with time zoneThe timestamp of the audit event.
datajsonbAdditional data relating to the audit event.
idtextThe id of the audit event.
includetextThe event types to include: web, git, all.
organizationrequiredtextThe GitHub organization.
phrasetextThe search phrase for your audit events.
repotextThe GitHub repository, when the action relates to a repository.
teamtextThe GitHub team, when the action relates to a team.
user_logintextThe GitHub user, when the action relates to a user.

Branch

The github_branch table offers valuable information on branches found in GitHub repositories. Developers or project managers can use this table to delve into branch-specific data like names, commits, protection status, and relevant metadata. It can help in discovering details about branches, such as those with protection enabled, the commits linked to each branch, and the status of branch protections.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
branch_protection_rulejsonbBranch protection rule if protected.
commitjsonbLatest commit on the branch.
nametextName of the branch.
protectedbooleanIf true, the branch is protected.
repository_full_namerequiredtextFull name of the repository that contains the branch.

Branch Protection

The github_branch_protection table offers information on branch protection rules in GitHub. Whether you're a DevOps engineer or a repository manager, this table allows you to delve into specific branch details, like enforcing status checks, pull request reviews, and push restrictions. Use it to discover insights on branch protections, such as strict requirements, enforcing signed commits, and limitations on push permissions for certain users.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
allows_deletionsbooleanIf true, allow users with push access to delete matching branches.
allows_force_pushesbooleanIf true, permit force pushes for all users with push access.
blocks_creationsbooleanIf true, indicates that branch creation is a protected operation.
bypass_force_push_allowance_appsjsonbApplications can force push to the branch only if in this list.
bypass_force_push_allowance_teamsjsonbTeams can force push to the branch only if in this list.
bypass_force_push_allowance_usersjsonbUsers can force push to the branch only if in this list.
bypass_pull_request_allowance_appsjsonbApplications can bypass pull requests to the branch only if in this list.
bypass_pull_request_allowance_teamsjsonbTeams can bypass pull requests to the branch only if in this list.
bypass_pull_request_allowance_usersjsonbUsers can bypass pull requests to the branch only if in this list.
creator_logintextThe login of the user whom created the branch protection rule.
dismisses_stale_reviewsbooleanIf true, new commits pushed to matching branches dismiss pull request review approvals.
idbigintThe ID of the branch protection rule.
is_admin_enforcedbooleanIf true, enforce all configured restrictions for administrators.
lock_allows_fetch_and_mergebooleanIf true, users can pull changes from upstream when the branch is locked.
lock_branchbooleanIf true, matching branches are read-only and cannot be pushed to.
matching_branchesbigintCount of branches which match this rule.
node_idtextThe Node ID of the branch protection rule.
patterntextThe protection rule pattern.
push_allowance_appsjsonbApplications can push to the branch only if in this list.
push_allowance_teamsjsonbTeams can push to the branch only if in this list.
push_allowance_usersjsonbUsers can push to the branch only if in this list.
repository_full_namerequiredtextThe full name of the repository (login/repo-name).
require_last_push_approvalbooleanIf true, the most recent push must be approved by someone other than the person who pushed it.
required_approving_review_countbigintNumber of approving reviews required to update matching branches.
required_deployment_environmentsjsonbList of required deployment environments that must be deployed successfully to update matching branches.
required_status_checksjsonbStatus checks that must pass before a branch can be merged into branches matching this rule.
requires_approving_reviewsbooleanIf true, approving reviews required to update matching branches.
requires_code_owner_reviewsbooleanIf true, reviews from code owners are required to update matching branches.
requires_commit_signaturesbooleanIf true, commits are required to be signed by verified signatures.
requires_conversation_resolutionbooleanIf true, requires all comments on the pull request to be resolved before it can be merged to a protected branch.
requires_deploymentsbooleanIf true, matching branches require deployment to specific environments before merging.
requires_linear_historybooleanIf true, prevent merge commits from being pushed to matching branches.
requires_status_checksbooleanIf true, status checks are required to update matching branches.
requires_strict_status_checksbooleanIf true, branches required to be up to date before merging.
restricts_pushesbooleanIf true, pushing to matching branches is restricted.
restricts_review_dismissalsbooleanIf true, review dismissals are restricted.

Code Owner

The github_code_owner table offers information about the code owners in a GitHub repository. Repository administrators can utilize this table to identify the owners of different sections of the codebase and to guarantee that all modifications undergo review by the relevant parties. This table is also beneficial for developers seeking to identify the appropriate contacts for specific code sections, and for project managers aiming to grasp the allocation of code ownership in a project.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
linebigintThe rule's line number in the CODEOWNERS file.
line_commenttextSpecifies the comment following the node and before empty lines.
patterntextThe pattern used to identify what code a team, or an individual is responsible for
pre_commentsjsonbSpecifies the comments added above a key.
repository_full_namerequiredtextThe full name of the repository, including the owner and repo name.
teamsjsonbTeams responsible for code in the repo
usersjsonbUsers responsible for code in the repo

Commit

The github_commit table offers information on individual commits in a GitHub repository. Developers and project managers can delve into commit-related details in this table, such as author details, commit messages, and timestamps. Use this resource to gain insights into the development timeline, monitor code modifications, and evaluate development trends in your projects.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
additionsbigintNumber of additions in the commit.
authorjsonbThe commit author.
author_logintextThe login name of the author of the commit.
authored_by_committerbooleanCheck if the committer and the author match.
authored_datetimestamp with time zoneTimestamp when the author made this commit.
can_subscribebooleanIf true, user can subscribe to this commit.
changed_filesbigintCount of files changed in the commit.
commit_urltextURL of the commit.
committed_datetimestamp with time zoneTimestamp when commit was committed.
committed_via_webbooleanIf true, commit was made via GitHub web ui.
committerjsonbThe committer.
committer_logintextThe login name of the committer.
deletionsbigintNumber of deletions in the commit.
messagetextCommit message.
message_headlinetextThe Git commit message headline.
node_idtextThe node ID of the commit.
repository_full_namerequiredtextFull name of the repository that contains the commit.
shatextSHA of the commit.
short_shatextShort SHA of the commit.
signaturejsonbThe signature of commit.
statusjsonbStatus of the commit.
subscriptiontextUsers subscription state of the commit.
tarball_urltextURL to download a tar of commit.
tree_urltextURL to tree of the commit.
urltextURL of the commit.
zipball_urltextURL to download a zip of commit.

Community Profile

The github_community_profile table offers information on the well-being and engagement of Github repositories. Whether you are a repository owner or contributor, you can delve into this table to find information such as the availability of contributing guidelines, code of conduct, and issue templates. This resource can be used to assess the overall status of repositories, gauge their community involvement, and pinpoint areas that may need enhancement.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
code_of_conductjsonbCode of conduct for the repository.
contributingjsonbContributing guidelines for the repository.
issue_templatesjsonbIssue template for the repository.
license_infojsonbLicense for the repository.
pull_request_templatesjsonbPull request template for the repository.
readmejsonbREADME for the repository.
repository_full_namerequiredtextFull name of the repository that contains the tag.
securityjsonbSecurity for the repository.

Gist

The table github_gist offers valuable information on Gists found on GitHub. Developers and team leaders can use this table to delve into specific details about Gists, like descriptions, comments, files, forks, history, ownership, and privacy status. This resource can be utilized to discover more about Gists, such as their version history, fork information, and related comments.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
commentsbigintThe number of comments for the gist.
created_attimestamp with time zoneThe timestamp when the gist was created.
descriptiontextThe gist description.
filesjsonbFiles in the gist.
git_pull_urltextThe https url to pull or clone the gist.
git_push_urltextThe https url to push the gist.
html_urltextThe HTML URL of the gist.
idrequiredtextThe unique id of the gist.
node_idtextThe Node ID of the gist.
owner_idbigintThe user id (number) of the gist owner.
owner_logintextThe user login name of the gist owner.
owner_typetextThe type of the gist owner (User or Organization).
publicbooleanIf true, the gist is public, otherwise it is private.
updated_attimestamp with time zoneThe timestamp when the gist was last updated.

Gitignore

The github_gitignore table offers information about Gitignore templates that can be found on GitHub. If you are a developer or a DevOps engineer, you can use this table to delve into specific details of each template, such as its name and source. This resource can help you explore and comprehend the structure of available templates, enabling you to make an informed decision on which one to choose for your project.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
nametextName of the gitignore template.
sourcetextSource code of the gitignore template.

Issue

The table github_issue offers valuable information regarding issues found in GitHub repositories. Project managers and developers can use this table to delve into specific details about issues, like their status, assignees, labels, and associated metadata. It can be used to discover details about issues such as overdue tasks, how team members collaborate on particular issues, and the general progress of issues in a project.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
active_lock_reasontextReason that the conversation was locked.
assigneesjsonbA list of Users assigned to the issue.
assignees_total_countbigintCount of assignees on the issue.
authorjsonbThe actor who authored the issue.
author_associationtextAuthor's association with the subject of the issue.
author_logintextThe login of the issue author.
bodytextIdentifies the body of the issue.
body_urltextURL for this issue body.
closedbooleanIf true, issue is closed.
closed_attimestamp with time zoneTimestamp when issue was closed.
comments_total_countbigintCount of comments on the issue.
created_attimestamp with time zoneTimestamp when issue was created.
created_via_emailbooleanIf true, issue was created via email.
editorjsonbThe actor who edited the issue.
full_database_idbigintIdentifies the primary key from the database as a BigInt.
idbigintThe ID of the issue.
includes_created_editbooleanIf true, issue was edited and includes an edit with the creation data.
is_pinnedbooleanif true, this issue is currently pinned to the repository issues list.
is_read_by_userbooleanif true, this issue has been read by the user.
labelsjsonbA map of labels for the issue.
labels_srcjsonbThe first 100 labels associated to the issue.
labels_total_countbigintCount of labels on the issue.
last_edited_attimestamp with time zoneTimestamp when issue was last edited.
lockedbooleanIf true, issue is locked.
milestonejsonbThe milestone associated with the issue.
node_idtextThe node ID of the issue.
numberbigintThe issue number.
published_attimestamp with time zoneTimestamp when issue was published.
repository_full_namerequiredtextThe full name of the repository (login/repo-name).
statetextThe state of the issue.
state_reasontextThe reason for the issue state.
titletextThe title of the issue.
updated_attimestamp with time zoneTimestamp when issue was last updated.
urltextURL for the issue.
user_can_closebooleanIf true, user can close the issue.
user_can_reactbooleanIf true, user can react on the issue.
user_can_reopenbooleanIf true, user can reopen the issue.
user_can_subscribebooleanIf true, user can subscribe to the issue.
user_can_updatebooleanIf true, user can update the issue,
user_cannot_update_reasonsjsonbA list of reason why user cannot update the issue.
user_did_authorbooleanIf true, user authored the issue.
user_subscriptiontextSubscription state of the user to the issue.

Issue Comment

The table github_issue_comment offers detailed information on comments made on GitHub issues. If you are a project manager or developer, you can examine specific details about comments in this table, such as the commenter, time of creation, comment content, and related metadata. This resource can be used to monitor user interactions, collect feedback, track the progress of issue resolution, and foster teamwork in solving problems.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
authorjsonbThe actor who authored the comment.
author_associationtextAuthor's association with the subject of the issue/pr the comment was raised on.
author_logintextThe login of the comment author.
bodytextThe contents of the comment as markdown.
body_texttextThe contents of the comment as text.
can_deletebooleanIf true, user can delete the comment.
can_minimizebooleanIf true, user can minimize the comment.
can_reactbooleanIf true, user can react to the comment.
can_updatebooleanIf true, user can update the comment.
cannot_update_reasonsjsonbA list of reasons why user cannot update the comment.
created_attimestamp with time zoneTimestamp when comment was created.
created_via_emailbooleanIf true, comment was created via email.
did_authorbooleanIf true, user authored the comment.
editorjsonbThe actor who edited the comment.
editor_logintextThe login of the comment editor.
idbigintThe ID of the comment.
includes_created_editbooleanIf true, comment was edited and includes an edit with the creation data.
is_minimizedbooleanIf true, comment has been minimized.
last_edited_attimestamp with time zoneTimestamp when comment was last edited.
minimized_reasontextThe reason for comment being minimized.
node_idtextThe node ID of the comment.
numberrequiredbigintThe issue/pr number.
published_attimestamp with time zoneTimestamp when comment was published.
repository_full_namerequiredtextThe full name of the repository (login/repo-name).
updated_attimestamp with time zoneTimestamp when comment was last updated.
urltextURL for the comment.

License

The table github_license offers information on the various licenses employed in GitHub repositories. Whether you are a software developer or a supporter of open-source projects, you can delve into the details of these licenses using this table, which covers their permissions, requirements, and restrictions. This resource can help you grasp the terms governing the use, modification, and distribution of the software concerned.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
conditionsjsonbAn array of license conditions (include-copyright,disclose-source, etc).
descriptiontextThe license description.
featuredbooleanIf true, the license is 'featured' in the GitHub UI.
hiddenbooleanWhether the license should be displayed in license pickers.
implementationtextImplementation instructions for the license.
keytextThe unique key of the license.
limitationsjsonbAn array of limitations for the license (trademark-use, liability,warranty, etc).
nametextThe name of the license.
nicknametextThe customary short name of the license.
permissionsjsonbAn array of permissions for the license (private-use, commercial-use,modifications, etc).
pseudo_licensebooleanIndicates if the license is a pseudo-license placeholder (e.g. other, no-license).
spdx_idtextThe Software Package Data Exchange (SPDX) id of the license.
urltextThe HTML URL of the license.

My Gist

The table github_my_gist offers valuable information about Gists on GitHub. Developers and GitHub users can utilize this table to delve into specific details of Gists, such as file content, comments, and metadata. It can be used for managing and analyzing Gists based on various criteria like content, comments count, and file details within the Gists.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
commentsbigintThe number of comments for the gist.
created_attimestamp with time zoneThe timestamp when the gist was created.
descriptiontextThe gist description.
filesjsonbFiles in the gist.
git_pull_urltextThe https url to pull or clone the gist.
git_push_urltextThe https url to push the gist.
html_urltextThe HTML URL of the gist.
idtextThe unique id of the gist.
node_idtextThe Node ID of the gist.
owner_idbigintThe user id (number) of the gist owner.
owner_logintextThe user login name of the gist owner.
owner_typetextThe type of the gist owner (User or Organization).
publicbooleanIf true, the gist is public, otherwise it is private.
updated_attimestamp with time zoneThe timestamp when the gist was last updated.

My Issue

The table github_my_issue offers valuable information on individual issues within GitHub. Whether you are a project manager or developer, you can delve into specific issue details available in this table, such as the issue title, status, assignee, and related metadata. This table can be used to effectively oversee and monitor tasks, enhancements, and issues in your projects.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
active_lock_reasontextReason that the conversation was locked.
assigneesjsonbA list of Users assigned to the issue.
assignees_total_countbigintCount of assignees on the issue.
authorjsonbThe actor who authored the issue.
author_associationtextAuthor's association with the subject of the issue.
author_logintextThe login of the issue author.
bodytextIdentifies the body of the issue.
body_urltextURL for this issue body.
closedbooleanIf true, issue is closed.
closed_attimestamp with time zoneTimestamp when issue was closed.
comments_total_countbigintCount of comments on the issue.
created_attimestamp with time zoneTimestamp when issue was created.
created_via_emailbooleanIf true, issue was created via email.
editorjsonbThe actor who edited the issue.
full_database_idbigintIdentifies the primary key from the database as a BigInt.
idbigintThe ID of the issue.
includes_created_editbooleanIf true, issue was edited and includes an edit with the creation data.
is_pinnedbooleanif true, this issue is currently pinned to the repository issues list.
is_read_by_userbooleanif true, this issue has been read by the user.
labelsjsonbA map of labels for the issue.
labels_srcjsonbThe first 100 labels associated to the issue.
labels_total_countbigintCount of labels on the issue.
last_edited_attimestamp with time zoneTimestamp when issue was last edited.
lockedbooleanIf true, issue is locked.
milestonejsonbThe milestone associated with the issue.
node_idtextThe node ID of the issue.
numberbigintThe issue number.
published_attimestamp with time zoneTimestamp when issue was published.
repository_full_nametextThe full name of the repository (login/repo-name).
statetextThe state of the issue.
state_reasontextThe reason for the issue state.
titletextThe title of the issue.
updated_attimestamp with time zoneTimestamp when issue was last updated.
urltextURL for the issue.
user_can_closebooleanIf true, user can close the issue.
user_can_reactbooleanIf true, user can react on the issue.
user_can_reopenbooleanIf true, user can reopen the issue.
user_can_subscribebooleanIf true, user can subscribe to the issue.
user_can_updatebooleanIf true, user can update the issue,
user_cannot_update_reasonsjsonbA list of reason why user cannot update the issue.
user_did_authorbooleanIf true, user authored the issue.
user_subscriptiontextSubscription state of the user to the issue.

My Organization

The table github_my_organization offers valuable information about a user's main organization on GitHub. If you're a project manager or team leader, you can delve into organization-specific information using this table, such as member permissions, repository details, and administrative functions. Make use of this resource to efficiently manage your organization's projects and boost team efficiency.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
announcementtextThe text of the announcement.
announcement_expires_attimestamp with time zoneThe expiration date of the announcement, if any.
announcement_user_dismissiblebooleanIf true, the announcement can be dismissed by the user.
any_pinnable_itemsbooleanIf true, this organization has items that can be pinned to their profile.
avatar_urltextURL pointing to the organization's public avatar.
billing_emailtextThe email address for billing.
can_administerbooleanIf true, you can administer the organization.
can_changed_pinned_itemsbooleanIf true, you can change the pinned items on the organization's profile.
can_create_projectsbooleanIf true, you can create projects for the organization.
can_create_repositoriesbooleanIf true, you can create repositories for the organization.
can_create_teamsbooleanIf true, you can create teams within the organization.
can_sponsorbooleanIf true, you can sponsor this organization.
collaboratorsbigintThe number of collaborators for the organization.
created_attimestamp with time zoneTimestamp when the organization was created.
default_repo_permissiontextThe default repository permissions for the organization.
descriptiontextThe description of the organization.
emailtextThe email address associated with the organization.
estimated_next_sponsors_payout_in_centsbigintThe estimated next GitHub Sponsors payout for this organization in cents (USD).
followersbigintThe number of users following the organization.
followingbigintThe number of users followed by the organization.
has_organization_projectsbooleanIf true, the organization can use organization projects.
has_repository_projectsbooleanIf true, the organization can use repository projects.
has_sponsors_listingbooleanIf true, this organization has a GitHub Sponsors listing.
hooksjsonbThe Hooks of the organization.
idbigintThe ID number of the organization.
interaction_abilityjsonbThe interaction ability settings for this organization.
is_a_memberbooleanIf true, you are an active member of the organization.
is_followingbooleanIf true, you are following the organization.
is_sponsoringbooleanIf true, you are sponsoring the organization.
is_sponsoring_youbooleanIf true, you are sponsored by this organization.
is_verifiedbooleanIf true, the organization has verified its profile email and website.
locationtextThe organization's public profile location.
logintextThe login name of the organization.
members_allowed_repository_creation_typetextSpecifies which types of repositories non-admin organization members can create
members_can_create_internal_reposbooleanIf true, members can create internal repositories.
members_can_create_pagesbooleanIf true, members can create pages.
members_can_create_private_reposbooleanIf true, members can create private repositories.
members_can_create_public_reposbooleanIf true, members can create public repositories.
members_can_create_reposbooleanIf true, members can create repositories.
members_can_fork_private_reposbooleanIf true, members can fork private organization repositories.
members_with_role_total_countbigintCount of members with a role within the organization.
monthly_estimated_sponsors_income_in_centsbigintThe estimated monthly GitHub Sponsors income for this organization in cents (USD).
nametextThe display name of the organization.
new_team_urltextURL for creating a new team.
node_idtextThe node ID of the organization.
packages_total_countbigintCount of packages within the organization.
pinnable_items_total_countbigintCount of pinnable items within the organization.
pinned_items_remainingbigintReturns how many more items this organization can pin to their profile.
pinned_items_total_countbigintCount of itesm pinned to the organization's profile.
plan_filled_seatsbigintThe number of used seats for the plan.
plan_nametextThe name of the GitHub plan.
plan_private_reposbigintThe number of private repositories for the plan.
plan_seatsbigintThe number of available seats for the plan
plan_spacebigintThe total space allocated for the plan.
private_repositories_total_countbigintCount of private repositories within the organization.
projects_total_countbigintCount of projects within the organization.
projects_urltextURL listing organization's projects.
projects_v2_total_countbigintCount of V2 projects within the organization.
public_repositories_total_countbigintCount of public repositories within the organization.
repositories_total_countbigintCount of all repositories within the organization.
repositories_total_disk_usagebigintTotal disk usage for all repositories within the organization.
saml_identity_providerjsonbThe Organization's SAML identity provider. Visible to (1) organization owners, (2) organization owners' personal access tokens (classic) with read:org or admin:org scope, (3) GitHub App with an installation token with read or write access to members, else null.
sponsoring_total_countbigintCount of users the organization is sponsoring.
sponsors_listingjsonbThe GitHub sponsors listing for this organization.
sponsors_total_countbigintCount of sponsors the organization has.
teams_total_countbigintCount of teams within the organization.
teams_urltextURL listing organization's teams.
total_sponsorship_amount_as_sponsor_in_centsbigintThe amount in United States cents (e.g., 500 = $5.00 USD) that this entity has spent on GitHub to fund sponsorships. Only returns a value when viewed by the user themselves or by a user who can manage sponsorships for the requested organization.
twitter_usernametextThe organization's Twitter username.
two_factor_requirement_enabledbooleanIf true, all members in the organization must have two factor authentication enabled.
updated_attimestamp with time zoneTimestamp when the organization was last updated.
urltextThe URL for this organization.
web_commit_signoff_requiredbooleanIf true, contributors are required to sign off on web-based commits for repositories in this organization.
website_urltextURL for the organization's public website.

My Repository

The table github_my_repository offers valuable information about individual GitHub repositories. For developers or project managers, this table allows you to delve into specific repository details like its name, description, owner, and visibility. You can use this table to oversee and control your repositories by checking visibility, reviewing descriptions, and identifying owners.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
allow_update_branchbooleanIf true, a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
archived_attimestamp with time zoneTimestamp when repository was archived.
auto_merge_allowedbooleanIf true, auto-merge can be enabled on pull requests in this repository.
can_administerbooleanIf true, you can administer this repository.
can_create_projectsbooleanIf true, you can create projects in this repository.
can_subscribebooleanIf true, you can subscribe to this repository.
can_update_topicsbooleanIf true, you can update topics on this repository.
code_of_conductjsonbThe code of conduct for this repository.
contact_linksjsonbList of contact links associated to the repository.
created_attimestamp with time zoneTimestamp when the repository was created.
default_branch_refjsonbDefault ref information.
delete_branch_on_mergebooleanIf true, branches are automatically deleted when merged in this repository.
descriptiontextThe description of the repository.
disk_usagebigintNumber of kilobytes this repository occupies on disk.
fork_countbigintNumber of forks there are of this repository in the whole network.
forking_allowedbooleanIf true, repository allows forks.
funding_linksjsonbThe funding links for this repository.
has_discussions_enabledbooleanIf true, the repository has the Discussions feature enabled.
has_downloadsbooleanIf true, the GitHub Downloads feature is enabled on the repository.
has_issues_enabledbooleanIf true, the repository has issues feature enabled.
has_pagesbooleanIf true, the GitHub Pages feature is enabled on the repository.
has_projects_enabledbooleanIf true, the repository has the Projects feature enabled.
has_starredbooleanIf true, you have starred this repository.
has_vulnerability_alerts_enabledbooleanIf true, vulnerability alerts are enabled for the repository.
has_wiki_enabledbooleanIf true, the repository has wiki feature enabled.
homepage_urltextThe external URL of the repository if set.
hooksjsonbThe API Hooks URL.
idbigintThe numeric ID of the repository.
interaction_abilityjsonbThe interaction ability settings for this repository.
is_archivedbooleanIf true, the repository is unmaintained (archived).
is_blank_issues_enabledbooleanIf true, blank issue creation is allowed.
is_disabledbooleanIf true, this repository disabled.
is_emptybooleanIf true, this repository is empty.
is_forkbooleanIf true, the repository is a fork.
is_in_organizationbooleanIf true, repository is either owned by an organization, or is a private fork of an organization repository.
is_lockedbooleanIf true, repository is locked.
is_mirrorbooleanIf true, the repository is a mirror.
is_privatebooleanIf true, the repository is private or internal.
is_security_policy_enabledbooleanIf true, repository has a security policy.
is_templatebooleanIf true, the repository is a template that can be used to generate new repositories.
is_user_configuration_repositorybooleanIf true, this is a user configuration repository.
issue_templatesjsonbA list of issue templates associated to the repository.
license_infojsonbThe license associated with the repository.
lock_reasontextThe reason the repository has been locked.
merge_commit_allowedbooleanIf true, PRs are merged with a merge commit on this repository.
merge_commit_messagetextHow the default commit message will be generated when merging a pull request.
merge_commit_titletextHow the default commit title will be generated when merging a pull request.
mirror_urltextThe repository's original mirror URL.
nametextThe name of the repository.
name_with_ownertextThe repository's name with owner.
network_countbigintThe number of member repositories in the network.
node_idtextThe node ID of the repository.
open_graph_image_urltextThe image used to represent this repository in Open Graph data.
open_issues_total_countbigintCount of issues open on the repository.
owner_logintextLogin of the repository owner.
possible_commit_emailsjsonbA list of emails you can commit to this repository with.
primary_languagejsonbThe primary language of the repository's code.
projects_urltextThe URL listing the repository's projects.
pull_request_templatesjsonbReturns a list of pull request templates associated to the repository.
pushed_attimestamp with time zoneTimestamp when the repository was last pushed to.
rebase_merge_allowedbooleanIf true, rebase-merging is enabled on this repository.
repository_topics_total_countbigintCount of topics associated with the repository.
security_policy_urltextThe security policy URL.
squash_merge_allowedbooleanIf true, squash-merging is enabled on this repository.
squash_merge_commit_messagetextHow the default commit message will be generated when squash merging a pull request.
squash_merge_commit_titletextHow the default commit title will be generated when squash merging a pull request.
ssh_urltextThe SSH URL to clone this repository.
stargazer_countbigintReturns a count of how many stargazers there are on this repository.
subscribers_countbigintThe number of users who have subscribed to the repository.
subscriptiontextIdentifies if the current user is watching, not watching, or ignoring the repository.
topicsjsonbThe topics (similar to tags or labels) associated with the repository.
updated_attimestamp with time zoneTimestamp when repository was last updated.
urltextThe URL of the repository.
uses_custom_open_graph_imagebooleanif true, this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.
visibilitytextIndicates the repository's visibility level.
watchers_total_countbigintCount of watchers on the repository.
web_commit_signoff_requiredbooleanIf true, contributors are required to sign off on web-based commits in this repository.
your_permissiontextYour permission level on the repository. Will return null if authenticated as an GitHub App.

My Star

The table github_my_star offers valuable information about the repositories that have been starred by the GitHub user who is currently logged in. Developers and project managers can use this table to delve into specific repository details such as names, owners, and the dates when stars were added. This data can be leveraged to study user preferences, identify new areas of interest, and efficiently handle the repositories that have been starred.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
repository_full_nametextThe full name of the repository, including the owner and repo name.
starred_attimestamp with time zoneThe timestamp when the repository was starred.
urltextURL of the repository.

My Team

The table github_my_team offers valuable information about teams in GitHub. Developers and project managers can use this table to delve into team-specific information, such as access rights, team organization, and linked repositories. This resource can help reveal details about teams, like which teams have administrative privileges for repositories, how access rights are distributed among team members, and the verification of team members.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
ancestors_total_countbigintCount of ancestors this team has.
avatar_urltextURL for teams avatar.
can_administerbooleanIf true, current user can administer the team.
can_subscribebooleanIf true, current user can subscribe to the team.
child_teams_total_countbigintCount of children teams this team has.
combined_slugtextThe slug corresponding to the organization and the team.
created_attimestamp with time zoneTimestamp when team was created.
descriptiontextThe description of the team.
discussions_total_countbigintCount of team discussions.
discussions_urltextURL for team discussions.
edit_team_urltextURL for editing this team.
idbigintThe ID of the team.
invitations_total_countbigintCount of outstanding team member invitations for the team.
members_total_countbigintCount of team members.
members_urltextURL for team members.
nametextThe name of the team.
new_team_urltextThe HTTP URL creating a new team.
node_idtextThe node id of the team.
organizationtextThe organization the team is associated with.
parent_teamjsonbThe teams parent team.
privacytextThe privacy setting of the team (VISIBLE or SECRET).
projects_v2_total_countbigintCount of the teams v2 projects.
repositories_total_countbigintCount of repositories the team has.
repositories_urltextURL for team repositories.
slugtextThe team slug name.
subscriptiontextSubscription status of the current user to the team.
teams_urltextURL for this team's teams.
updated_attimestamp with time zoneTimestamp when team was last updated.
urltextURL for the team page in GitHub.

Organization

The table github_organization offers information on Organizations on GitHub. Developers and project managers can use this table to access organization-specific details, such as profile information, public repository count, and associated metadata. It can be used to discover details about organizations like their location, public repository count, and other profile information.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
announcementtextThe text of the announcement.
announcement_expires_attimestamp with time zoneThe expiration date of the announcement, if any.
announcement_user_dismissiblebooleanIf true, the announcement can be dismissed by the user.
any_pinnable_itemsbooleanIf true, this organization has items that can be pinned to their profile.
avatar_urltextURL pointing to the organization's public avatar.
billing_emailtextThe email address for billing.
can_administerbooleanIf true, you can administer the organization.
can_changed_pinned_itemsbooleanIf true, you can change the pinned items on the organization's profile.
can_create_projectsbooleanIf true, you can create projects for the organization.
can_create_repositoriesbooleanIf true, you can create repositories for the organization.
can_create_teamsbooleanIf true, you can create teams within the organization.
can_sponsorbooleanIf true, you can sponsor this organization.
collaboratorsbigintThe number of collaborators for the organization.
created_attimestamp with time zoneTimestamp when the organization was created.
default_repo_permissiontextThe default repository permissions for the organization.
descriptiontextThe description of the organization.
emailtextThe email address associated with the organization.
estimated_next_sponsors_payout_in_centsbigintThe estimated next GitHub Sponsors payout for this organization in cents (USD).
followersbigintThe number of users following the organization.
followingbigintThe number of users followed by the organization.
has_organization_projectsbooleanIf true, the organization can use organization projects.
has_repository_projectsbooleanIf true, the organization can use repository projects.
has_sponsors_listingbooleanIf true, this organization has a GitHub Sponsors listing.
hooksjsonbThe Hooks of the organization.
idbigintThe ID number of the organization.
interaction_abilityjsonbThe interaction ability settings for this organization.
is_a_memberbooleanIf true, you are an active member of the organization.
is_followingbooleanIf true, you are following the organization.
is_sponsoringbooleanIf true, you are sponsoring the organization.
is_sponsoring_youbooleanIf true, you are sponsored by this organization.
is_verifiedbooleanIf true, the organization has verified its profile email and website.
locationtextThe organization's public profile location.
loginrequiredtextThe login name of the organization.
members_allowed_repository_creation_typetextSpecifies which types of repositories non-admin organization members can create
members_can_create_internal_reposbooleanIf true, members can create internal repositories.
members_can_create_pagesbooleanIf true, members can create pages.
members_can_create_private_reposbooleanIf true, members can create private repositories.
members_can_create_public_reposbooleanIf true, members can create public repositories.
members_can_create_reposbooleanIf true, members can create repositories.
members_can_fork_private_reposbooleanIf true, members can fork private organization repositories.
members_with_role_total_countbigintCount of members with a role within the organization.
monthly_estimated_sponsors_income_in_centsbigintThe estimated monthly GitHub Sponsors income for this organization in cents (USD).
nametextThe display name of the organization.
new_team_urltextURL for creating a new team.
node_idtextThe node ID of the organization.
packages_total_countbigintCount of packages within the organization.
pinnable_items_total_countbigintCount of pinnable items within the organization.
pinned_items_remainingbigintReturns how many more items this organization can pin to their profile.
pinned_items_total_countbigintCount of itesm pinned to the organization's profile.
plan_filled_seatsbigintThe number of used seats for the plan.
plan_nametextThe name of the GitHub plan.
plan_private_reposbigintThe number of private repositories for the plan.
plan_seatsbigintThe number of available seats for the plan
plan_spacebigintThe total space allocated for the plan.
private_repositories_total_countbigintCount of private repositories within the organization.
projects_total_countbigintCount of projects within the organization.
projects_urltextURL listing organization's projects.
projects_v2_total_countbigintCount of V2 projects within the organization.
public_repositories_total_countbigintCount of public repositories within the organization.
repositories_total_countbigintCount of all repositories within the organization.
repositories_total_disk_usagebigintTotal disk usage for all repositories within the organization.
saml_identity_providerjsonbThe Organization's SAML identity provider. Visible to (1) organization owners, (2) organization owners' personal access tokens (classic) with read:org or admin:org scope, (3) GitHub App with an installation token with read or write access to members, else null.
sponsoring_total_countbigintCount of users the organization is sponsoring.
sponsors_listingjsonbThe GitHub sponsors listing for this organization.
sponsors_total_countbigintCount of sponsors the organization has.
teams_total_countbigintCount of teams within the organization.
teams_urltextURL listing organization's teams.
total_sponsorship_amount_as_sponsor_in_centsbigintThe amount in United States cents (e.g., 500 = $5.00 USD) that this entity has spent on GitHub to fund sponsorships. Only returns a value when viewed by the user themselves or by a user who can manage sponsorships for the requested organization.
twitter_usernametextThe organization's Twitter username.
two_factor_requirement_enabledbooleanIf true, all members in the organization must have two factor authentication enabled.
updated_attimestamp with time zoneTimestamp when the organization was last updated.
urltextThe URL for this organization.
web_commit_signoff_requiredbooleanIf true, contributors are required to sign off on web-based commits for repositories in this organization.
website_urltextURL for the organization's public website.

Organization Dependabot Alert

The table github_organization_dependabot_alert offers valuable information on Dependabot Alerts in GitHub. Whether you are a security analyst or developer, you can investigate specific alert details such as status, severity, and package name using this table. It serves as a tool to discover details about security vulnerabilities in your GitHub organization's dependencies, assisting you in maintaining the safety and freshness of your projects.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
alert_numberbigintThe security alert number.
created_attimestamp with time zoneThe time that the alert was created.
dependency_manifest_pathtextThe unique manifestation path within the ecosystem.
dependency_package_ecosystemtextThe package's language or package management ecosystem.
dependency_package_nametextThe unique package name within its ecosystem.
dependency_scopetextThe execution scope of the vulnerable dependency.
dismissed_attimestamp with time zoneThe time that the alert was dismissed.
dismissed_commenttextAn optional comment associated with the alert's dismissal.
dismissed_reasontextThe reason that the alert was dismissed.
fixed_attimestamp with time zoneThe time that the alert was no longer detected and was considered fixed.
html_urltextThe GitHub URL of the alert resource.
organizationrequiredtextThe login name of the organization.
security_advisory_cve_idtextThe unique CVE ID assigned to the advisory.
security_advisory_cvss_scoredouble precisionThe overall CVSS score of the advisory.
security_advisory_cvss_vector_stringtextThe full CVSS vector string for the advisory.
security_advisory_cwesjsonbThe associated CWEs
security_advisory_descriptiontextA long-form Markdown-supported description of the advisory.
security_advisory_ghsa_idtextThe unique GitHub Security Advisory ID assigned to the advisory.
security_advisory_published_attimestamp with time zoneThe time that the advisory was published.
security_advisory_severitytextThe severity of the advisory.
security_advisory_summarytextA short, plain text summary of the advisory.
security_advisory_updated_attimestamp with time zoneThe time that the advisory was last modified.
security_advisory_withdrawn_attimestamp with time zoneThe time that the advisory was withdrawn.
statetextThe state of the Dependabot alert.
updated_attimestamp with time zoneThe time that the alert was last updated.
urltextThe REST API URL of the alert resource.

Organization External Identity

The table github_organization_external_identity offers information on the external identities of users in a GitHub organization. As an administrator of a GitHub organization, you can utilize this table to obtain a thorough view of the connected identities of users in your Identity Provider. This is especially beneficial when overseeing users in organizations that utilize SAML single sign-on (SSO) with GitHub.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
guidtextGuid identifier for the external identity.
organizationrequiredtextThe organization the external identity is associated with.
organization_invitationjsonbThe invitation to the organization.
saml_identityjsonbThe external SAML identity.
scim_identityjsonbThe external SCIM identity.
user_detailjsonbThe GitHub user details.
user_logintextThe GitHub user login.

Organization Member

The github_organization_member table offers valuable information about the members belonging to a GitHub organization. Project managers and team leaders can use this table to delve into individual member details, such as their roles, permissions, and current status. It is a useful tool for discovering information like members' organizational roles, access levels, and activity status.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
any_pinnable_itemsbooleanIf true, user has pinnable items.
avatar_urltextThe URL of the user's avatar.
biotextThe biography of the user.
can_changed_pinned_itemsbooleanIf true, you can change the pinned items for this user.
can_create_projectsbooleanIf true, you can create projects for this user.
can_followbooleanIf true, you can follow this user.
can_sponsorbooleanIf true, you can sponsor this user.
companytextThe company on the users profile.
created_attimestamp with time zoneTimestamp when user was created.
emailtextThe email of the user.
estimated_next_sponsors_payout_in_centsbigintThe estimated next GitHub sponsors payout for this user in cents (USD).
has_sponsors_listingbooleanIf true, user has a GitHub sponsors listing.
has_two_factor_enabledbooleanWhether the organization member has two factor enabled or not. Returns null if information is not available to viewer.
idbigintThe ID of the user.
interaction_abilityjsonbThe interaction ability settings for this user.
is_bounty_hunterbooleanIf true, user is a participant in the GitHub security bug bounty.
is_campus_expertbooleanIf true, user is a participant in the GitHub campus experts program.
is_developer_program_memberbooleanIf true, user is a GitHub developer program member.
is_employeebooleanIf true, user is a GitHub employee.
is_followingbooleanIf true, you are following this user.
is_following_youbooleanIf true, user follows you.
is_github_starbooleanIf true, user is a member of the GitHub Stars Program.
is_hireablebooleanIf true, user has marked themselves as for hire.
is_site_adminbooleanIf true, user is a site administrator.
is_sponsoringbooleanIf true, you are sponsoring this user.
is_sponsoring_youbooleanIf true, this user is sponsoring you.
is_youbooleanIf true, user is you.
locationtextThe location of the user.
logintextThe login name of the user.
monthly_estimated_sponsors_income_in_centsbigintThe estimated monthly GitHub sponsors income for this user in cents (USD).
nametextThe name of the user.
node_idtextThe node ID of the user.
organizationrequiredtextThe organization the member is associated with.
pinned_items_remainingbigintHow many more items this user can pin to their profile.
projects_urltextThe URL listing user's projects.
pronounstextThe user's pronouns.
roletextThe role this user has in the organization. Returns null if information is not available to viewer.
sponsors_listingjsonbThe GitHub sponsors listing for this user.
statusjsonbThe user's status.
twitter_usernametextTwitter username of the user.
updated_attimestamp with time zoneTimestamp when user was last updated.
urltextThe URL of the user's GitHub page.
website_urltextThe URL pointing to the user's public website/blog.

Pull Request

The table github_pull_request offers valuable information about pull requests on GitHub. Developers and project managers can use this table to investigate specific details related to pull requests, such as their status, assignees, reviewers, and associated metadata. This tool can be utilized for monitoring the advancement of pull requests, pinpointing obstacles in the review process, and guaranteeing prompt merging of authorized modifications.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
active_lock_reasontextReason that the conversation was locked.
additionsbigintThe number of additions in this pull request.
assigneesjsonbA list of Users assigned to the pull request.
assignees_total_countbigintA count of users assigned to the pull request.
authorjsonbThe author of the pull request.
author_associationtextAuthor's association with the pull request.
base_refjsonbThe base ref associated with the pull request.
base_ref_nametextIdentifies the name of the base Ref associated with the pull request, even if the ref has been deleted.
bodytextThe body as Markdown.
can_apply_suggestionbooleanIf true, current user can apply suggestions.
can_closebooleanIf true, current user can close the pull request.
can_delete_head_refbooleanIf true, current user can delete/restore head ref.
can_disable_auto_mergebooleanIf true, current user can disable auto-merge.
can_edit_filesbooleanIf true, current user can edit files within this pull request.
can_enable_auto_mergebooleanIf true, current user can enable auto-merge.
can_merge_as_adminbooleanIf true, current user can bypass branch protections and merge the pull request immediately.
can_reactbooleanIf true, current user can react to the pull request.
can_reopenbooleanIf true, current user can reopen the pull request.
can_subscribebooleanIf true, current user can subscribe to the pull request.
can_updatebooleanIf true, current user can update the pull request.
can_update_branchbooleanIf true, current user can update the head ref of the pull request by merging or rebasing the base ref.
cannot_update_reasonsjsonbReasons why the current user cannot update the pull request, if applicable.
changed_filesbigintThe number of files changed in this pull request.
checks_urltextURL for the checks of this pull request.
closedbooleanIf true, pull request is closed.
closed_attimestamp with time zoneTimestamp when the pull request was closed.
commits_total_countbigintA count of commits in the pull request.
created_attimestamp with time zoneTimestamp when the pull request was created.
created_via_emailbooleanIf true, pull request comment was created via email.
deletionsbigintThe number of deletions in this pull request.
did_authorbooleanIf true, current user authored the pull request.
editorjsonbThe actor who edited the pull request's body.
head_refjsonbThe head ref associated with the pull request.
head_ref_nametextIdentifies the name of the head Ref associated with the pull request, even if the ref has been deleted.
head_ref_oidtextIdentifies the oid/sha of the head ref associated with the pull request, even if the ref has been deleted.
idbigintThe ID of the pull request.
includes_created_editbooleanIf true, this pull request was edited and includes an edit with the creation data.
is_cross_repositorybooleanIf true, head and base repositories are different.
is_draftbooleanIf true, the pull request is a draft.
is_read_by_userbooleanIf true, this pull request was read by the current user.
labelsjsonbA map of labels for the pull request.
labels_srcjsonbThe first 100 labels associated to the pull request.
labels_total_countbigintA count of labels applied to the pull request.
last_edited_attimestamp with time zoneTimestamp the editor made the last edit.
lockedbooleanIf true, the pull request is locked.
maintainer_can_modifybooleanIf true, maintainers can modify the pull request.
merge_commitjsonbThe merge commit associated the pull request, null if not merged.
mergeabletextWhether or not the pull request can be merged based on the existence of merge conflicts.
mergedbooleanIf true, the pull request was merged.
merged_attimestamp with time zoneTimestamp when pull request was merged.
merged_byjsonbThe actor who merged the pull request.
milestonejsonbThe milestone associated with the pull request.
node_idtextThe node ID of the pull request.
numberbigintThe number of the pull request.
permalinktextPermanent URL for the pull request.
published_attimestamp with time zoneTimestamp the pull request was published.
repository_full_namerequiredtextThe full name of the repository the pull request belongs to.
revert_urltextURL to revert the pull request.
review_decisiontextThe current status of this pull request with respect to code review.
review_requests_total_countbigintA count of reviews requested on the pull request.
reviews_total_countbigintA count of completed reviews on the pull request.
statetextThe current state of the pull request.
subscriptiontextStatus of current users subscription to the pull request.
suggested_reviewersjsonbSuggested reviewers for the pull request.
titletextThe title of the pull request.
total_comments_countbigintThe number of comments on the pull request.
updated_attimestamp with time zoneTimestamp when the pull request was last updated.
urltextURL of the pull request.

Pull Request Comment

The table github_pull_request_comment offers valuable information about comments left on pull requests in a GitHub repository. Developers and project managers can delve into specific comment details in this table, such as the comment's content, author, date of creation, and related metadata. This resource can be used to gain insights into discussions and feedback on pull requests, helping to improve code reviews and encourage collaborative decision-making.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
authorjsonbThe actor who authored the comment.
author_associationtextAuthor's association with the subject of the issue/pr the comment was raised on.
author_logintextThe login of the comment author.
bodytextThe contents of the comment as markdown.
body_texttextThe contents of the comment as text.
can_deletebooleanIf true, user can delete the comment.
can_minimizebooleanIf true, user can minimize the comment.
can_reactbooleanIf true, user can react to the comment.
can_updatebooleanIf true, user can update the comment.
cannot_update_reasonsjsonbA list of reasons why user cannot update the comment.
created_attimestamp with time zoneTimestamp when comment was created.
created_via_emailbooleanIf true, comment was created via email.
did_authorbooleanIf true, user authored the comment.
editorjsonbThe actor who edited the comment.
editor_logintextThe login of the comment editor.
idbigintThe ID of the comment.
includes_created_editbooleanIf true, comment was edited and includes an edit with the creation data.
is_minimizedbooleanIf true, comment has been minimized.
last_edited_attimestamp with time zoneTimestamp when comment was last edited.
minimized_reasontextThe reason for comment being minimized.
node_idtextThe node ID of the comment.
numberrequiredbigintThe issue/pr number.
published_attimestamp with time zoneTimestamp when comment was published.
repository_full_namerequiredtextThe full name of the repository (login/repo-name).
updated_attimestamp with time zoneTimestamp when comment was last updated.
urltextURL for the comment.

Pull Request Review

The github_pull_request_review table offers information about how pull requests are reviewed on GitHub. Developers and team leads can use this table to delve into specific review details, such as comments, status, and reviewer information. This tool can help you grasp the feedback given on pull requests, track the approval status, and understand the code review procedures implemented in your projects.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
authorjsonbThe actor who authored the review.
author_associationtextAuthor's association with the subject of the pr the review was raised on.
author_can_push_to_repositorybooleanIndicates whether the author of this review has push access to the repository.
author_logintextThe login of the review author.
bodytextThe body of the review.
idbigintThe ID of the review.
node_idtextThe node ID of the review.
numberrequiredbigintThe PR number.
repository_full_namerequiredtextThe full name of the repository (login/repo-name).
statetextThe state of the review.
submitted_attimestamp with time zoneIdentifies when the Pull Request Review was submitted.
urltextThe HTTP URL permalink for this PullRequestReview.

Rate Limit

The github_rate_limit table offers information on the rate limits established by GitHub for API usage. Developers and system administrators can utilize this table to track their application's API usage and ensure it remains within the specified limits to prevent any disruptions in service. Additionally, this table is valuable for strategizing and enhancing the allocation of API requests to boost efficiency and prevent hitting the rate limit.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
core_limitbigintThe number of requests per hour the client is currently limited to.
core_remainingbigintThe number of remaining requests the client can make this hour.
core_resettimestamp with time zoneThe time at which the current rate limit will reset.
search_limitbigintThe number of requests per hour the client is currently limited to.
search_remainingbigintThe number of remaining requests the client can make this hour.
search_resettimestamp with time zoneThe time at which the current rate limit will reset.

Rate Limit Graphql

The table github_rate_limit_graphql offers information about the rate limiting status of GitHub's GraphQL API. Developers or DevOps engineers can utilize this table to keep track of their application's current rate limit status for API usage. This tool is valuable for overseeing and improving how API requests are managed to remain within the permissible limits.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
costbigintNumber of points used to return this query.
limitbigintMaximum number of points used that can be used in current allocation.
node_countbigintNumber of nodes returned by this query.
remainingbigintNumber of points remaining in current allocation.
reset_attimestamp with time zoneTimestamp when the allocation resets.
usedbigintNumber of points used from current allocation.

Release

The GitHub Release table offers valuable information on GitHub Releases within a repository. For software developers or project managers, this table allows you to delve into specific details related to releases, such as release ID, tag name, draft status, prerelease status, and other relevant information. You can use this tool to monitor the development and status of various software versions, pinpoint any prerelease versions, and enhance the management of your software releases.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
assetsjsonbList of assets contained in the release.
assets_urltextAssets URL for the release.
author_logintextThe login name of the user that created the release.
bodytextText describing the contents of the tag.
created_attimestamp with time zoneTime when the release was created.
draftbooleanTrue if this is a draft (unpublished) release.
html_urltextHTML URL for the release.
idbigintUnique ID of the release.
nametextThe name of the release.
node_idtextNode where GitHub stores this data internally.
prereleasebooleanTrue if this is a prerelease version.
published_attimestamp with time zoneTime when the release was published.
repository_full_namerequiredtextFull name of the repository that contains the release.
tag_nametextThe name of the tag the release is associated with.
tarball_urltextTarball URL for the release.
target_commitishtextSpecifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA.
upload_urltextUpload URL for the release.
urltextURL of the release.
zipball_urltextZipball URL for the release.

Repository

The table github_repository offers valuable information about GitHub repositories. Developers or project managers can use this table to delve into specific repository details, like owner information, repository names, descriptions, and visibility status. It can be used to discover details about the repositories, such as their visibility (public or private), the owner of each repository, and the description of its contents.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
allow_update_branchbooleanIf true, a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
archived_attimestamp with time zoneTimestamp when repository was archived.
auto_merge_allowedbooleanIf true, auto-merge can be enabled on pull requests in this repository.
can_administerbooleanIf true, you can administer this repository.
can_create_projectsbooleanIf true, you can create projects in this repository.
can_subscribebooleanIf true, you can subscribe to this repository.
can_update_topicsbooleanIf true, you can update topics on this repository.
code_of_conductjsonbThe code of conduct for this repository.
contact_linksjsonbList of contact links associated to the repository.
created_attimestamp with time zoneTimestamp when the repository was created.
default_branch_refjsonbDefault ref information.
delete_branch_on_mergebooleanIf true, branches are automatically deleted when merged in this repository.
descriptiontextThe description of the repository.
disk_usagebigintNumber of kilobytes this repository occupies on disk.
fork_countbigintNumber of forks there are of this repository in the whole network.
forking_allowedbooleanIf true, repository allows forks.
full_namerequiredtextThe full name of the repository, including the owner and repo name.
funding_linksjsonbThe funding links for this repository.
has_discussions_enabledbooleanIf true, the repository has the Discussions feature enabled.
has_downloadsbooleanIf true, the GitHub Downloads feature is enabled on the repository.
has_issues_enabledbooleanIf true, the repository has issues feature enabled.
has_pagesbooleanIf true, the GitHub Pages feature is enabled on the repository.
has_projects_enabledbooleanIf true, the repository has the Projects feature enabled.
has_starredbooleanIf true, you have starred this repository.
has_vulnerability_alerts_enabledbooleanIf true, vulnerability alerts are enabled for the repository.
has_wiki_enabledbooleanIf true, the repository has wiki feature enabled.
homepage_urltextThe external URL of the repository if set.
hooksjsonbThe API Hooks URL.
idbigintThe numeric ID of the repository.
interaction_abilityjsonbThe interaction ability settings for this repository.
is_archivedbooleanIf true, the repository is unmaintained (archived).
is_blank_issues_enabledbooleanIf true, blank issue creation is allowed.
is_disabledbooleanIf true, this repository disabled.
is_emptybooleanIf true, this repository is empty.
is_forkbooleanIf true, the repository is a fork.
is_in_organizationbooleanIf true, repository is either owned by an organization, or is a private fork of an organization repository.
is_lockedbooleanIf true, repository is locked.
is_mirrorbooleanIf true, the repository is a mirror.
is_privatebooleanIf true, the repository is private or internal.
is_security_policy_enabledbooleanIf true, repository has a security policy.
is_templatebooleanIf true, the repository is a template that can be used to generate new repositories.
is_user_configuration_repositorybooleanIf true, this is a user configuration repository.
issue_templatesjsonbA list of issue templates associated to the repository.
license_infojsonbThe license associated with the repository.
lock_reasontextThe reason the repository has been locked.
merge_commit_allowedbooleanIf true, PRs are merged with a merge commit on this repository.
merge_commit_messagetextHow the default commit message will be generated when merging a pull request.
merge_commit_titletextHow the default commit title will be generated when merging a pull request.
mirror_urltextThe repository's original mirror URL.
nametextThe name of the repository.
name_with_ownertextThe repository's name with owner.
network_countbigintThe number of member repositories in the network.
node_idtextThe node ID of the repository.
open_graph_image_urltextThe image used to represent this repository in Open Graph data.
open_issues_total_countbigintCount of issues open on the repository.
owner_logintextLogin of the repository owner.
possible_commit_emailsjsonbA list of emails you can commit to this repository with.
primary_languagejsonbThe primary language of the repository's code.
projects_urltextThe URL listing the repository's projects.
pull_request_templatesjsonbReturns a list of pull request templates associated to the repository.
pushed_attimestamp with time zoneTimestamp when the repository was last pushed to.
rebase_merge_allowedbooleanIf true, rebase-merging is enabled on this repository.
repository_topics_total_countbigintCount of topics associated with the repository.
security_policy_urltextThe security policy URL.
squash_merge_allowedbooleanIf true, squash-merging is enabled on this repository.
squash_merge_commit_messagetextHow the default commit message will be generated when squash merging a pull request.
squash_merge_commit_titletextHow the default commit title will be generated when squash merging a pull request.
ssh_urltextThe SSH URL to clone this repository.
stargazer_countbigintReturns a count of how many stargazers there are on this repository.
subscribers_countbigintThe number of users who have subscribed to the repository.
subscriptiontextIdentifies if the current user is watching, not watching, or ignoring the repository.
topicsjsonbThe topics (similar to tags or labels) associated with the repository.
updated_attimestamp with time zoneTimestamp when repository was last updated.
urltextThe URL of the repository.
uses_custom_open_graph_imagebooleanif true, this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.
visibilitytextIndicates the repository's visibility level.
watchers_total_countbigintCount of watchers on the repository.
web_commit_signoff_requiredbooleanIf true, contributors are required to sign off on web-based commits in this repository.
your_permissiontextYour permission level on the repository. Will return null if authenticated as an GitHub App.

Repository Collaborator

The table github_repository_collaborator offers information about the collaborators linked to GitHub repositories. If you manage a repository, you can utilize this table to investigate collaborators' details, such as their permissions and the status of any invitations they have. This information is valuable for controlling access and making sure that each collaborator has the correct level of permissions.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
affiliationtextAffiliation filter - valid values 'ALL' (default), 'OUTSIDE', 'DIRECT'.
permissiontextThe permission the collaborator has on the repository.
repository_full_namerequiredtextThe full name of the repository, including the owner and repo name.
user_logintextThe login of the collaborator

Repository Dependabot Alert

The table github_repository_dependabot_alert offers valuable information on Dependabot alerts in GitHub repositories. If you are a project maintainer or security engineer, you can examine specific alert details in this table, such as the dependency's name, version, and linked security vulnerabilities. This resource can assist you in identifying potentially unsafe dependencies, enabling you to uphold your projects' security and reliability.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
alert_numberbigintThe security alert number.
created_attimestamp with time zoneThe time that the alert was created.
dependency_manifest_pathtextThe unique manifestation path within the ecosystem.
dependency_package_ecosystemtextThe package's language or package management ecosystem.
dependency_package_nametextThe unique package name within its ecosystem.
dependency_scopetextThe execution scope of the vulnerable dependency.
dismissed_attimestamp with time zoneThe time that the alert was dismissed.
dismissed_commenttextAn optional comment associated with the alert's dismissal.
dismissed_reasontextThe reason that the alert was dismissed.
fixed_attimestamp with time zoneThe time that the alert was no longer detected and was considered fixed.
html_urltextThe GitHub URL of the alert resource.
repository_full_namerequiredtextThe full name of the repository (login/repo-name).
security_advisory_cve_idtextThe unique CVE ID assigned to the advisory.
security_advisory_cvss_scoredouble precisionThe overall CVSS score of the advisory.
security_advisory_cvss_vector_stringtextThe full CVSS vector string for the advisory.
security_advisory_cwesjsonbThe associated CWEs
security_advisory_descriptiontextA long-form Markdown-supported description of the advisory.
security_advisory_ghsa_idtextThe unique GitHub Security Advisory ID assigned to the advisory.
security_advisory_published_attimestamp with time zoneThe time that the advisory was published.
security_advisory_severitytextThe severity of the advisory.
security_advisory_summarytextA short, plain text summary of the advisory.
security_advisory_updated_attimestamp with time zoneThe time that the advisory was last modified.
security_advisory_withdrawn_attimestamp with time zoneThe time that the advisory was withdrawn.
statetextThe state of the Dependabot alert.
updated_attimestamp with time zoneThe time that the alert was last updated.
urltextThe REST API URL of the alert resource.

Repository Deployment

The table github_repository_deployment provides valuable information on the deployment details of GitHub repositories. For developers or project managers, this table can be utilized to access deployment status, environment, and associated metadata for individual repositories. This resource is beneficial for tracking deployment advancement, recognizing deployment trends, and addressing deployment challenges.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
commit_shatextSHA of the commit the deployment is using.
created_attimestamp with time zoneTimestamp when the deployment was created.
creatorjsonbThe deployment creator.
descriptiontextThe description of the deployment.
environmenttextThe name of the environment to which the deployment was made.
idbigintThe ID of the deployment.
latest_environmenttextThe name of the latest environment to which the deployment was made.
latest_statusjsonbThe latest status of the deployment.
node_idtextThe node ID of the deployment.
original_environmenttextThe original environment to which this deployment was made.
payloadtextExtra information that a deployment system might need.
refjsonbIdentifies the Ref of the deployment, if the deployment was created by ref.
repository_full_namerequiredtextThe full name of the repository (login/repo-name).
statetextThe current state of the deployment.
tasktextThe deployment task.
updated_attimestamp with time zoneTimestamp when the deployment was last updated.

Repository Environment

The github_repository_environment table offers information about GitHub repository environments. DevOps engineers and repository managers can use this table to delve into specific environment details such as names, URLs, and protection rules. It can be utilized for overseeing and controlling the deployment process to ensure safe and secure software deployment.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
idbigintThe ID of the environment.
nametextThe name of the environment.
node_idtextThe node ID of the environment.
repository_full_namerequiredtextThe full name of the repository (login/repo-name).

Repository Sbom

The table github_repository_sbom offers valuable information on the Software Bill of Materials (SBOM) for GitHub Repositories. For software developers or security analysts, this table allows you to delve into the components, versions, and dependencies of a software application. It can be used to reveal important details about the SBOM, like the components utilized in a software application, their versions, and dependencies. This information is vital for vulnerability management and maintaining software integrity.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
creation_infojsonbIt represents when the SBOM was created and who created it.
data_licensetextThe license under which the SPDX document is licensed.
document_describesjsonbThe name of the repository that the SPDX document describes.
document_namespacetextThe namespace for the SPDX document.
nametextThe name of the SPDX document.
packagesjsonbArray of packages in SPDX format.
repository_full_namerequiredtextThe full name of the repository (login/repo-name).
spdx_idtextThe SPDX identifier for the SPDX document.
spdx_versiontextThe version of the SPDX specification that this document conforms to.

Repository Vulnerability Alert

The table github_repository_vulnerability_alert offers information on repository vulnerability alerts in GitHub. Security analysts can examine specific details in the table, such as the status of alerts, the names of affected packages, and the affected ranges. This resource can be used to discover details about possible vulnerabilities, like highly severe ones, affected package versions, and confirming if fixed versions are available.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
auto_dismissed_attimestamp with time zoneTimestamp at which the vulnerability alert was automatically dismissed.
created_attimestamp with time zoneTimestamp when the vulnerability alert was created.
cvss_scoredouble precisionThe CVSS score of the advisory associated with the vulnerability alert.
dependency_scopetextThe dependency scope of the vulnerability alert, will be RUNTIME or DEVELOPMENT.
dismiss_commenttextComment on the dismissal of the vulnerability alert.
dismiss_reasontextReason for the dismissal of the vulnerability alert.
dismissed_attimestamp with time zoneTimestamp at which the vulnerability alert was dismissed.
dismisserjsonbThe user whom dismissed the vulnerability alert.
fixed_attimestamp with time zoneTimestamp when the vulnerability alert was marked as fixed.
node_idtextThe node id of the vulnerability alert.
numberbigintNumber of vulnerability alert.
repository_full_namerequiredtextThe full name of the repository, including the owner and repo name.
security_advisoryjsonbThe security advisory associated with the vulnerability alert.
security_vulnerabilityjsonbThe vulnerability associated with the vulnerability alert.
severitytextSeverity of the vulnerability.
statetextState of the vulnerability alert, will be 'OPEN', 'FIXED' or 'DISMISSED'.
vulnerable_manifest_filenametextFilename of the vulnerable manifest.
vulnerable_manifest_pathtextPath of the vulnerable manifest.
vulnerable_requirementstextVulnerable requirements from the manifest.

Search Code

The table github_search_code offers valuable information about the code files found in GitHub repositories. Developers and DevOps engineers can use this table to delve into specific details of files, such as their names, paths, and related metadata. It is a useful resource for discovering details about the codebase, such as the types of files present, the organization of the repositories, and specifics about the code files.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
html_urltextThe complete URL of the file where the match has been found.
nametextThe name of the file where the match has been found.
pathtextThe path of the file where the match has been found.
queryrequiredtextThe query used to match the code.
repositoryjsonbThe repository details of the file where the match has been found.
repository_full_nametextThe full name of the repository (login/repo-name).
shatextThe SHA of the file where the match has been found.
text_matchesjsonbThe text match details.

Search Commit

The github_search_commit table provides valuable information on commit activities in GitHub repositories. Developers and project managers can use this table to monitor project progress, track changes, and ensure version control. It can be employed to search for particular commits using different criteria like author, date, and associated message.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
authorjsonbThe author details.
comments_urltextThe API URL of the comments made on the commit.
commitjsonbThe commit details.
committerjsonbThe committer details.
html_urltextThe Github URL of the commit.
parentsjsonbThe parent details.
queryrequiredtextThe query used to match the commit.
repositoryjsonbThe repository details of the commit.
repository_full_nametextThe full name of the repository (login/repo-name).
scoredouble precisionThe score of the commit.
shatextThe SHA of the commit.
urltextThe API URL of the commit.

Search Issue

The github_search_issue table offers a glimpse into problems found in GitHub repositories. Whether you're a project manager or developer, you can delve into issue-related specifics via this table, which includes information on status, assignees, labels, and related metadata. This resource can be used to reveal details about issues like their open status, the individuals assigned to them, and the labels linked to them.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
active_lock_reasontextReason that the conversation was locked.
assigneesjsonbA list of Users assigned to the issue.
assignees_total_countbigintCount of assignees on the issue.
authorjsonbThe actor who authored the issue.
author_associationtextAuthor's association with the subject of the issue.
author_logintextThe login of the issue author.
bodytextIdentifies the body of the issue.
body_urltextURL for this issue body.
closedbooleanIf true, issue is closed.
closed_attimestamp with time zoneTimestamp when issue was closed.
comments_total_countbigintCount of comments on the issue.
created_attimestamp with time zoneTimestamp when issue was created.
created_via_emailbooleanIf true, issue was created via email.
editorjsonbThe actor who edited the issue.
full_database_idbigintIdentifies the primary key from the database as a BigInt.
idbigintThe ID of the issue.
includes_created_editbooleanIf true, issue was edited and includes an edit with the creation data.
is_pinnedbooleanif true, this issue is currently pinned to the repository issues list.
is_read_by_userbooleanif true, this issue has been read by the user.
labelsjsonbA map of labels for the issue.
labels_srcjsonbThe first 100 labels associated to the issue.
labels_total_countbigintCount of labels on the issue.
last_edited_attimestamp with time zoneTimestamp when issue was last edited.
lockedbooleanIf true, issue is locked.
milestonejsonbThe milestone associated with the issue.
node_idtextThe node ID of the issue.
numberbigintThe issue number.
published_attimestamp with time zoneTimestamp when issue was published.
queryrequiredtextThe query provided for the search.
repository_full_nametextThe full name of the repository (login/repo-name).
statetextThe state of the issue.
state_reasontextThe reason for the issue state.
text_matchesjsonbThe text match details.
titletextThe title of the issue.
updated_attimestamp with time zoneTimestamp when issue was last updated.
urltextURL for the issue.
user_can_closebooleanIf true, user can close the issue.
user_can_reactbooleanIf true, user can react on the issue.
user_can_reopenbooleanIf true, user can reopen the issue.
user_can_subscribebooleanIf true, user can subscribe to the issue.
user_can_updatebooleanIf true, user can update the issue,
user_cannot_update_reasonsjsonbA list of reason why user cannot update the issue.
user_did_authorbooleanIf true, user authored the issue.
user_subscriptiontextSubscription state of the user to the issue.

Search Label

The data in the github_search_label table offers valuable information about Labels in GitHub. Whether you're a project manager or a developer, you can delve into specific label characteristics presented in this table, such as color, default status, and linked metadata. This resource can be used to discover details about labels, such as how they are used in issues and pull requests, aiding in streamlined project management and issue tracking.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
colortextThe color assigned to the label.
defaultbooleanWhether the label is a default one.
descriptiontextThe description of the label.
idbigintThe ID of the label.
nametextThe name of the label.
queryrequiredtextThe query used to match the label.
repository_full_nametextThe full name of the repository (login/repo-name).
repository_idrequiredbigintThe ID of the repository.
scoredouble precisionThe score of the label.
text_matchesjsonbThe text match details.
urltextThe API URL to get the label details.

Search Pull Request

The table github_search_pull_request offers valuable information about pull requests in GitHub. Developers and project managers can use this table to delve into details related to pull requests, such as their status, creator, assignee, and related metadata. You can utilize this resource to track the advancement of suggested modifications, conduct code reviews, and uphold code quality in your repositories.

Fields

NameTypeDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
active_lock_reasontextReason that the conversation was locked.
additionsbigintThe number of additions in this pull request.
assigneesjsonbA list of Users assign