getUserRepos Documentation

Purpose

This node retrieve a user's repositories from GitHub through its API. It provides a simple interface for specifying various parameters, such as pagination and visibility filters, allowing developers to integrate GitHub repository data into their applications with ease.

Settings

This node has several settings that dictate its behavior and output. Each setting is explained in detail below:

1. page

• Input Type: Numeric
• Description: This setting defines the page number of the results returned by GitHub's API. By changing this value, users can navigate through different pages of repositories. For example, setting page to 2 will retrieve the repositories on the second page.
• Default Value: 1

2. perPage

• Input Type: Numeric
• Description: This setting specifies the number of repositories to return per page. Increasing this value will result in more repositories being retrieved in one API call, which can improve performance if many repositories exist. Conversely, a lower value may help with rendering times in applications with limited display space.
• Default Value: 30

3. visibility

• Input Type: Dropdown (Enum)
• Options: 'all', 'public', 'private'
• Description: This setting determines the visibility filter for the repositories being fetched.
  • 'all' retrieves all repositories (both public and private).
  • 'public' retrieves only public repositories.
  • 'private' retrieves only private repositories. Changing this setting allows users to focus on specific types of repositories based on their privacy settings.
• Default Value: RepoVisibility.ALL

How It Works

The node works by:

1. Accepting an inputs object which may contain specific parameters for page, perPage, and visibility.
2. Fallbacks to config or defaults if parameters are not provided in the inputs.
3. Building a connection to the GitHub API using a secure connection.
4. Calling the getUserRepos method of the GitHub integration with the specified parameters to fetch the repository data.
5. Returning the output data containing the user's repositories or an error message if the API call fails.

Expected Data

The node expects the following inputs:

• inputs: An object that may include page, perPage, and visibility.
• config: Configuration settings used as fallbacks for the inputs.
• context: Contextual data used for establishing the connection to GitHub.

Error Handling

If an internal error occurs during the integration call, the function returns an object with an error message that includes the specific error encountered. This helps in debugging issues related to the GitHub service.

AI Integrations & Billing Impact

The getUserRepos component leverages the GitHub API to fetch data, which might have associated costs depending on the GitHub account type and usage patterns, particularly for high-volume data retrieval. Ensure that any high-limit API usage is monitored to prevent exceeding GitHub rate limits or incurring additional charges.

Use Cases & Examples

Use Cases

1. Portfolio Display: A developer wants to display their GitHub repositories on their personal website to showcase their work. They can use getUserRepos to fetch all public repositories and list them with project details.

2. Dashboards for Team Projects: A project manager needs to keep track of repositories related to their team's work on GitHub. Using getUserRepos, they can filter repositories based on visibility to display relevant private repositories only.

3. Data Analytics: A data analyst is tasked with analyzing the repository performance for all users in a GitHub organization. Using the getUserRepos component, they can gather statistics about public repositories from multiple users efficiently.

Concrete Example

Use Case: Portfolio Display

To configure this node for displaying a developer's public repositories on their portfolio, the following input settings can be provided:

{
  "inputs": {
    "visibility": "public",
    "perPage": 10,
    "page": 1
  },
  "config": {
    // additional configuration settings if needed
  },
  "context": {
    // authentication or context details for GitHub access
  }
}

In this configuration:

• visibility is set to "public" to ensure only public repositories are fetched.
• perPage is set to 10 to limit the results displayed on each page of the portfolio.
• page is intentionally kept at 1 to start with the first page of results.