Skip to content
Nappai Documentation

GitHub Issues

This component lets you pull information about issues from your GitHub repositories into your Nappai dashboard. You can filter the issues to show only those that meet specific criteria, making it easy to monitor project progress, track bugs, or analyze trends.

Relationship with GitHub

This component connects directly to the GitHub API to retrieve issue data. You’ll need a personal access token to authorize Nappai to access your GitHub repositories.

Inputs

  • Access Token: This is a special code that allows Nappai to securely access your GitHub account. You’ll need to generate this token in your GitHub settings. Do not share this token with anyone.
  • Repository: The name of the GitHub repository you want to get issues from (e.g., my-organization/my-project).
  • Labels: (Optional) You can filter issues by specifying one or more labels. Enter each label separated by a comma (e.g., bug,enhancement). Leave this blank to see all issues.
  • State: (Optional) Choose whether to show open, closed, or all issues. The default is “all”.

Outputs

The component produces a list of GitHub issues. Each issue includes information like its title, description, status (open or closed), labels, and other metadata. This data can then be used by other Nappai components for further processing, such as summarizing, categorizing, or displaying on charts and graphs in your dashboard.

Usage Example

Let’s say you want to see all open issues in your repository labeled “bug”. You would:

  1. Enter your GitHub Access Token.
  2. Enter your Repository name (e.g., my-organization/my-project).
  3. Enter bug in the Labels field.
  4. Leave the State field as “open” (or “all” to see both open and closed issues).

The component will then fetch and display all issues matching these criteria.

Templates

[List of templates where the component can be seen and its configuration - This section needs to be populated based on the actual templates used.]

  • Summarizer: Use this component to automatically summarize the descriptions of many GitHub issues.
  • Categorizer: Categorize issues based on their labels or descriptions.
  • Google Sheet Writer: Export the issue data to a Google Sheet for further analysis.
  • Scorer: Assign a score to each issue based on its priority or severity.

Tips and Best Practices

  • Generate a new Access Token: Create a new access token specifically for Nappai. This improves security. Revoke old tokens when no longer needed.
  • Use specific labels: Using labels effectively helps you filter and organize your issues.
  • Test your configuration: Start with a small set of filters to ensure the component is working correctly before applying more complex filters.

Security Considerations

  • Protect your Access Token: Never share your GitHub Access Token. Treat it like a password.
  • Use the least privilege principle: Only grant the necessary permissions to your access token. Review the permissions regularly.
  • Regularly review your access tokens: Revoke any tokens that are no longer needed.