Skip to content
Nappai Documentation

GitHub Issues

⚠️ DEPRECATION WARNING

This component is deprecated and will be removed in a future version of Nappai. Please migrate to the recommended alternative components.

The GitHub Issues component lets you pull issue data from a GitHub repository so you can analyze, display, or process it in your Nappai dashboard.

How it Works

When you add this component to a workflow, it connects to the GitHub API using the access token you provide.
It then retrieves the list of issues from the specified repository, optionally filtering by:

  • Labels – only issues that have the selected labels.
  • State – open, closed, or all issues.

The component returns each issue as a Data object that contains the issue text and metadata (such as title, number, and URL). These objects can be passed to other components for further processing or display.

Inputs

  • Access Token: Your GitHub access token.
  • Labels: Filter on label names.
  • Repository: Repository to access.
  • State: Filter on issue state.

Outputs

  • Data: A list of Data objects (method: fetch_content). Each object holds the issue content and its metadata.

Usage Example

  1. Add the component to your workflow.
  2. Enter your GitHub access token in the Access Token field.
  3. Specify the repository (e.g., octocat/Hello-World).
  4. Set the state to open to get only open issues.
  5. Add a label (e.g., bug) if you only want issues tagged as bugs.
  6. Connect the output to a Data Viewer or Table component to display the issues in your dashboard.

This setup will show all open bug issues from the chosen repository in a clean, readable format.

  • GitHub Pull Requests – Fetch pull request data from a repository.
  • GitHub Commits – Retrieve commit history for analysis or display.
  • GitHub Repositories – List repositories under a user or organization.

Tips and Best Practices

  • Keep your GitHub access token secret; store it in Nappai’s secure variable store.
  • Use the State filter to limit the amount of data fetched and improve performance.
  • If you only need a few labels, list them in the Labels field to reduce noise.
  • Combine this component with a Filter or Sort component to organize the issues before displaying them.

Security Considerations

  • The access token grants read access to the specified repository. Treat it like a password.
  • Never expose the token in public dashboards or logs.
  • Use Nappai’s built‑in secret management to store and inject the token securely.