5 min read

getOrgRepos Documentation

Overview

This node interface with GitHub's API, enabling the retrieval of repository data for a specified organization. This functionality is useful for users who want to analyze or display repositories owned by a GitHub organization, categorized by various criteria such as visibility and pagination controls.

Purpose

The primary purpose of this node is to fetch a list of repositories for a specified organization from GitHub. This list can be filtered based on repository visibility (public, private, etc.), and the component includes pagination support to manage large sets of data effectively.

Settings

The getOrgRepos component includes several settings that determine its configuration. Below is an exhaustive breakdown of each setting.

Setting Name	Input Type	Description	Default Value
`org`	String	This setting specifies the GitHub organization whose repositories you wish to retrieve. If not specified, it defaults to 'octocat', a commonly used placeholder organization. Changing this value will alter the output to reflect the repositories of the specified organization.	'octocat'
`page`	Numeric	This setting indicates which page of results to return when pagination is utilized. The default is set to 1, meaning the first page of results will be returned initially. Increasing the page number will result in fetching subsequent pages of results.	1
`perPage`	Numeric	This setting sets the number of repositories returned per page. The default value is 30, but it can be adjusted to any valid integer as permitted by GitHub's API limits. Increasing this value will yield more repositories per request, potentially leading to larger data sets for each API call.	30
`type`	Dropdown	This setting allows users to specify the visibility of the repositories they wish to retrieve. The options typically include `public`, `private`, and `all`. The default is set to `RepoVisibility.ALL`, which fetches all available repositories regardless of their visibility. Selecting a different option will filter the returned repositories accordingly.	`RepoVisibility.ALL`

How It Works

The getOrgRepos component operates asynchronously to ensure non-blocking data retrieval. When invoked, it checks for the existence of required parameters, specifically the organization name. If the organization is not specified, an error is thrown, ensuring proper usage of the component.

The steps involved in the execution are as follows:

Input Validation: The component checks for the org, page, perPage, and type settings in the inputs and config objects. If org is missing, an error is raised.
Build Connection: A connection instance is created using the the integration connection function, designed to handle the GitHub API's authentication and request formation.
Data Retrieval: Once the connection is established, the component makes an API call to integration.getOrgRepos, passing in the necessary parameters to fetch the organization's repositories.
Output Handling: The returned data is formatted under the key output1. In case of an error during the data retrieval process, an error message is returned instead.

Expected Data

The getOrgRepos component expects the following data types for its settings:

org: Expected to be a string (GitHub Organization Name).
page: Expected to be a numeric value (Integer).
perPage: Expected to be a numeric value (Integer).
type: Expected to be a valid repository visibility type (string), where options include public, private, or all.

AI Integrations

As of the current implementation, there are no direct AI integrations associated with this node. The primary function of this component is the retrieval of data rather than data analysis or transformation that would typically involve AI.

Billing Impacts

Using the getOrgRepos component will incur standard billing charges associated with API calls to GitHub's services, as dictated by their API rate limits and pricing model. Each call made to retrieve repositories counts towards the allocated GitHub API usage for your integration, which could result in costs if usage exceeds the free tier limits.

Use Cases & Examples

Use Cases

Organizational Repository Audit: A tech team wants to audit all repositories within a GitHub organization to identify unused or obsolete projects. They can utilize getOrgRepos to list all repositories and review their activity.
Data Visualization Dashboard: A business intelligence team is building a dashboard that visualizes the number of repositories by type and their statuses. Using getOrgRepos, they can fetch repository data to visualize metrics.
Documentation Generation: A documentation team wants to automatically generate pages for each of their projects within a GitHub organization using the repository names and descriptions fetched from GitHub.

Configuration Example

To implement the functionality for an Organizational Repository Audit, the configuration might look as follows:

Sample Configuration Data:

json

{
  "inputs": {
    "org": "my-org",
    "page": 1,
    "perPage": 50,
    "type": "all"
  },
  "config": {},
  "context": {}
}

In this configuration:

org is set to "my-org", specifying the organization to review.
page is set to 1, requesting the first page of results.
perPage is set to 50, which increases the number of repositories fetched per call for easier auditing.
type is set to "all", ensuring both public and private repositories are included in the results.

This configuration will allow the team to retrieve a comprehensive list of repositories belonging to the specified organization, facilitating their audit process efficiently.

← PreviousGitHub Get Repo Next →GitHub Get User Repos