Can the provided code successfully extract GitHub team discussions?

Help
1

This topic was automatically generated from Slack. You can find the original thread here.

will the following code work to pull github team discussions ?

import { axios } from “@pipedream/platform”;

export default defineComponent({
name: “velora-github-team-discussions-source-GET”,
description:
“This is a custom source for Velora AI, which fetches user credentials from an external source, and then uses the GET API to fetch GitHub team discussions, with 15-minute timer intervals.”,
props: {
github: {
type: “app”,
app: “github”,
},
timer: {
type: “$.interface.timer”,
default: {
intervalSeconds: 15 * 60,
},
},
org: {
type: “string”,
label: “Organization Name”,
description: “Enter the name of the GitHub organization.”,
},
team_slug: {
type: “string”,
label: “Team Slug”,
description: “Enter the slug of the GitHub team.”,
},
nangoConnect: {
type: “string”,
label: “Nango Connection ID”,
description: “Enter the Nango Connection ID”,
},
nangoIntegrate: {
type: “string”,
label: “Nango Integration ID”,
description: “Enter the Nango Integration ID”,
},
},
dedupe: “greatest”,
async run({ steps, $ }) {
// Retrieve the GitHub token from Nango
const nangoResponse = await axios($, {
method: “GET”,
headers: {
Authorization: Bearer ${process.env.VELORA_NANGO_SECRET_KEY},
},
url: https://api.nango.dev/connection/${this.nangoConnect}?provider_config_key=${this.nangoIntegrate},
});
const github_token = nangoResponse.credentials.access_token;

// Use the GitHub token to make a request to the GitHub API for team discussions
const discussions = await axios($, {
  method: "get",
  headers: {
    Authorization: `Bearer ${github_token}`,
    accept: "application/vnd.github+json",
  },
  url: `https://api.github.com/orgs/${this.org}/teams/${this.team_slug}/discussions`,
  params: {
    per_page: 100, // Adjust this value as needed
    page: 1, // Adjust this value as needed
  },
});

discussions.data.forEach((discussion) => {
  this.$emit(discussion, {
    id: discussion.id,
    summary: `DISCUSSION ${discussion.number}: ${discussion.title}`,
    body: discussion.body,
    ts: discussion.created_at && +new Date(discussion.created_at),
  });
});

},
});

2

The code you’ve provided aims to fetch GitHub team discussions using a GitHub token retrieved from Nango. While the approach is conceptually sound, there are several key points and modifications to consider ensuring it works as intended: 1. Environment Variable for Nango Secret Key: You’re using process.env.VELORA_NANGO_SECRET_KEY to pass the Nango secret key. Ensure that this environment variable is correctly set in the Pipedream environment where the code will run. 2. URL Syntax: The angle brackets < > around URLs in the axios calls are not standard syntax and should be removed. The correct syntax does not include these brackets. 3. Nango Integration: The code snippet assumes that Nango can retrieve a GitHub token. This requires that the Nango setup on your end is correctly configured to store and provide GitHub tokens. Ensure that the Nango connection and integration IDs provided are correct and that Nango is set up to handle GitHub OAuth tokens. 4. GitHub API Endpoint: The GitHub API endpoint used in the code is correct for fetching team discussions. However, ensure that the GitHub app has the necessary permissions and scopes (read:discussion or write:discussion) to access team discussions. 5. Error Handling: Consider adding error handling to the axios requests to manage and log errors that may occur during the API calls. This can help in debugging issues with the Nango connection or GitHub API requests. 6. Rate Limiting and Pagination: The GitHub API has rate limits. If you’re fetching a large number of discussions or have a high frequency of requests, be mindful of these limits. Additionally, the code handles pagination manually with a fixed page: 1. If you need to retrieve more discussions beyond the first page, you’ll need to implement pagination logic. 7. Dedupe Strategy: You’ve specified a dedupe: "greatest" strategy. Ensure this aligns with how you want to handle duplicate events in Pipedream. 8. Permissions and Access: The GitHub token used must have access to the specified organization and team. The user or integration that generated this token needs to be a part of the GitHub organization with access to the team discussions. Given these considerations, the code should work to pull GitHub team discussions if all setup and permissions are correctly configured. However, it’s crucial to test the integration thoroughly to catch any potential issues related to permissions, rate limiting, or incorrect

3

like how we pull github issues in the following code, give me code to pull github team discussions :

import { axios } from “@pipedream/platform”;

export default {
name: “Source Demo”,
description: “This is a demo source”,
props: {
github: {
type: “app”,
app: “github”,
},
timer: {
type: “$.interface.timer”,
default: {
intervalSeconds: 15 * 60,
},
},
},
dedupe: “greatest”,
async run() {
const data = await axios(this, {
method: “get”,
headers: {
Authorization: Bearer ${this.github.$auth.oauth_access_token},
},
url: https://api.github.com/repos/pddemo/demo/issues,
});
data.forEach((issue) => {
this.$emit(issue, {
id: issue.id,
summary: ISSUE ${issue.number}: ${issue.title},
ts: issue.created_at && +new Date(issue.created_at),
});
});
},
};

4

To modify the provided code to pull GitHub team discussions instead of issues, you’ll need to adjust the API endpoint and ensure you have the appropriate permissions set up, as accessing team discussions requires different scopes. The GitHub API endpoint for team discussions is different from the one for issues, and you’ll need to ensure the OAuth token has the right scopes (read:discussion or write:discussion). First, make sure your GitHub app has the read:discussion or write:discussion scope enabled. This will allow your Pipedream component to access team discussions. Here’s how you can modify the code to fetch team discussions: import { axios } from "@pipedream/platform"; export default defineComponent({ name: "Fetch GitHub Team Discussions", description: "This component fetches discussions from a GitHub team.", props: { github: { type: "app", app: "github", }, timer: { type: "$.interface.timer", default: { intervalSeconds: 15 * 60, // Adjust the interval as needed }, }, }, async run({ steps, $ }) { // Replace `ORG_NAME` with your GitHub organization name and `TEAM_SLUG` with the slug of your team const orgName = "ORG_NAME"; const teamSlug = "TEAM_SLUG"; const discussions = await axios(this, { method: "get", headers: { Authorization: `Bearer ${this.github.$auth.oauth_access_token}`, }, url: `https://api.github.com/orgs/${orgName}/teams/${teamSlug}/discussions`, }); discussions.forEach((discussion) => { this.$emit(discussion, { id: discussion.id, summary: `DISCUSSION ${discussion.number}: ${discussion.title}`, ts: discussion.created_at && +new Date(discussion.created_at), }); }); }, }); Please replace ORG_NAME with your actual GitHub organization name and TEAM_SLUG with the slug of your team. The slug is typically the team name in lowercase, replaced spaces with hyphens. Remember, accessing team discussions requires the read:discussion or write:discussion OAuth scope, so ensure your GitHub app connected to Pipedream has these scopes enabled. If you need to adjust the scopes for your GitHub app on Piped

5

can we modify the code to include params like this ?

const data = await axios($, {
method: “get”,
headers: {
Authorization: Bearer ${github_token},
accept: “application/vnd.github+json”,
},
url: https://api.github.com/orgs/${this.org}/teams/${this.team_slug}/discussions,
params: {
per_page: 100, // Adjust this value as needed
page: 1, // Adjust this value as needed
},
});

6

To modify the code to include parameters for making a GET request to the GitHub API to retrieve team discussions with pagination, you can follow this structure. Note that you need to replace github_token with the appropriate method to access the GitHub OAuth token provided by Pipedream’s GitHub app integration. Also, ensure that org and team_slug are defined either as props or within the function where they’re used. import { axios } from "@pipedream/platform"; export default defineComponent({ props: { github: { type: "app", app: "github", }, org: { type: "string", label: "Organization", description: "The GitHub organization.", }, team_slug: { type: "string", label: "Team Slug", description: "The slug of the GitHub team.", }, }, async run({ steps, $ }) { const data = await axios($, { method: "get", headers: { Authorization: `Bearer ${this.github.$auth.oauth_access_token}`, accept: "application/vnd.github+json", }, url: `https://api.github.com/orgs/${this.org}/teams/${this.team_slug}/discussions`, params: { per_page: 100, // Adjust this value as needed page: 1, // Adjust this value as needed }, }); return data; }, }); In this code snippet: - The GitHub OAuth token is accessed via this.github.$auth.oauth_access_token, which securely uses the token from the GitHub app integration in Pipedream. - The org and team_slug are defined as props, allowing you to input these values when you run the component. - The axios request includes the params object, specifying the per_page and page parameters for pagination control.