← Pipedream + GitHub integrations

Search Issues and Pull Requests with GitHub APIon New Records from SQL Query from Pipedream API

Pipedream makes it easy to connect APIs for GitHub, Pipedream and + other apps remarkably fast.

Trigger workflow on
New Records from SQL Query from the Pipedream API
Next, do this
Search Issues and Pull Requests with the GitHub API
No credit card required
Trusted by 200,000+ developers from startups to Fortune 500 companies:
Trusted by 200,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

This integration creates a workflow with a Pipedream trigger and GitHub action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Select this integration
  2. Configure the New Records from SQL Query trigger
    1. Configure timer
    2. Configure SQL Query
    3. Optional- Select a Result Type
    4. Optional- Configure Emit each record as its own event
    5. Connect your Pipedream account
  3. Configure the Search Issues and Pull Requests action
    1. Connect your GitHub account
    2. Configure Keywords
    3. Optional- Select a Sort
    4. Optional- Select a order
    5. Optional- Configure Auto-Paginate
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. Turn on the trigger

Details

This integration uses pre-built, open source components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger

Description:Runs a query against the Pipedream SQL Service on a schedule, emitting the results in batch (default) or with each record as its own event
Version:0.0.2
Key:pipedream-new-records-from-sql-query

Trigger Code

const pipedream = require("../../pipedream.app.js");

module.exports = {
  key: "pipedream-new-records-from-sql-query",
  name: "New Records from SQL Query",
  description:
    "Runs a query against the Pipedream SQL Service on a schedule, emitting the results in batch (default) or with each record as its own event",
  version: "0.0.2",
  dedupe: "unique", // Dedupes records based on the query execution ID
  props: {
    timer: {
      type: "$.interface.timer",
      default: {
        cron: "0 0 * * *",
      },
    },
    sqlQuery: {
      type: "string",
      label: "SQL Query",
      description:
        "Your SQL query (try running in [https://pipedream.com/sql](https://pipedream.com/sql) first)",
    },
    resultType: {
      type: "string",
      label: "Result Type",
      description: `Specifies how you want the query results formatted`,
      optional: true,
      options: ["array", "object", "csv"],
      default: "array",
    },
    emitEachRecordAsEvent: {
      type: "boolean",
      label: "Emit each record as its own event",
      description:
        "If `true`, each record in your results set is emitted as its own event. Defaults to emitting results as a single event (an array of records)",
      optional: true,
      default: false,
    },
    pipedream,
  },
  async run() {
    const results = await this.pipedream.runSQLQuery(
      this.sqlQuery,
      this.resultType
    );
    if (this.resultType === "array" && this.emitEachRecordAsEvent) {
      // First, extract the properties to include in every event
      const { columnInfo, queryExecutionId, csvLocation } = results;
      let event = {
        columnInfo,
        queryExecutionId,
        csvLocation,
      };
      const header = results.results.shift();
      for (const [i, row] of results.results.entries()) {
        let record = {};
        for (const [j, col] of header.entries()) {
          record[col] = row[j];
        }
        // For each record, emit an event
        this.$emit(
          {
            query: this.sqlQuery,
            results: {
              columnInfo,
              queryExecutionId,
              csvLocation,
              record,
            },
          },
          {
            summary: `${this.sqlQuery} - ${i}`,
            id: `${results.queryExecutionId}-${i}`,
          }
        );
      }
      return;
    }
    this.$emit(
      { query: this.sqlQuery, results },
      {
        summary: this.sqlQuery,
        id: results.queryExecutionId,
      }
    );
  },
};

Trigger Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
timer$.interface.timer
SQL QuerysqlQuerystring

Your SQL query (try running in https://pipedream.com/sql first)

Result TyperesultTypestringSelect a value from the drop down menu:arrayobjectcsv
Emit each record as its own eventemitEachRecordAsEventboolean

If true, each record in your results set is emitted as its own event. Defaults to emitting results as a single event (an array of records)

PipedreampipedreamappThis component uses the Pipedream app.

Trigger Authentication

Pipedream uses API keys for authentication. When you connect your Pipedream account, Pipedream securely stores the keys so you can easily authenticate to Pipedream APIs in both code and no-code steps.

Your API key is in your Account Settings (Settings -> Account).

About Pipedream

Integration platform for developers

Action

Description:Find issues by state and keyword.
Version:0.0.15
Key:github-search-issues-and-pull-requests

Action Code

const github = require('../../github.app.js')
const { Octokit } = require('@octokit/rest')

module.exports = {
  key: "github-search-issues-and-pull-requests",
  name: "Search Issues and Pull Requests",
  description: "Find issues by state and keyword.",
  version: "0.0.15",
  type: "action",
  props: {
    github,
    q: { propDefinition: [github, "q_issues_and_pull_requests"] },
    sort: { propDefinition: [github, "sortIssues"] },
    order: { propDefinition: [github, "order"] },
    paginate: { propDefinition: [github, "paginate"] },
  },
  async run() {
    const octokit = new Octokit({
      auth: this.github.$auth.oauth_access_token
    })
    
    if(this.paginate) {
      return await octokit.paginate(octokit.search.issuesAndPullRequests, { 
        q: this.q,
        sort: this.sort,
        order: this.order,
        per_page: 100,
      })
    } else {
      return (await octokit.search.issuesAndPullRequests({
        q: this.q,
        sort: this.sort,
        order: this.order,
        per_page: 100,
      })).data.items
    }
  },
}

Action Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

LabelPropTypeDescription
GitHubgithubappThis component uses the GitHub app.
Keywordsqstring

Enter one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub (this field supports the same qualifiers as search on GitHub.com). To learn more about the format of the query, see Constructing a search query. See Searching issues and pull requests for a detailed list of qualifiers.

SortsortstringSelect a value from the drop down menu:{ "label": "Best Match (default)", "value": "" }createdupdatedcommentsreactionsreactions-+1reactions--1reactions-smilereactions-thinking_facereactions-heartreactions-tadainteractions
orderorderstringSelect a value from the drop down menu:{ "label": "Descending", "value": "desc" }{ "label": "Ascending", "value": "asc" }
Auto-Paginatepaginateboolean

By default, retrieve all matching search results across all result pages. Set to false to limit results to the first page.

Action Authentication

GitHub uses OAuth authentication. When you connect your GitHub account, Pipedream will open a popup window where you can sign into GitHub and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any GitHub API.

Pipedream requests the following authorization scopes when you connect your account:

repoadmin:orgadmin:public_keyadmin:org_hookgistnotificationsuserwrite:discussionwrite:packagesread:packages

About GitHub

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

More Ways to Connect GitHub + Pipedream

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday
Powerful features that scale
Manage concurrency and execution rate
Manage concurrency and execution rate

Queue up to 10,000 events per workfow and manage the concurrency and rate at which workflows are triggered.

Process large payloads up to 5 terabytes
Process large payloads up to 5 terabytes

Large file support enables you to trigger workflows with any data (e.g., large JSON files, images and videos) up to 5 terabytes.

Return custom responses to HTTP requests
Return custom responses to HTTP requests

Return any JSON-serializable response from an HTTP triggered workflow using $respond().

Use most npm packages
Use most npm packages

To use any npm package, just require() it -- there's no npm install or package.json required.

Maintain state between executions
Maintain state between executions

Use $checkpoint to save state in one workflow invocation and read it the next time your workflow runs.

Pass data between steps
Pass data between steps

Return data from any step to inspect it in a human-friendly way and reference the data in future steps via the steps object.