← GitHub

Search Issues and Pull Requests with GitHub API

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

Trigger workflow on
HTTP requests, schedules and app events
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

Create a workflow to Search Issues and Pull Requests with the GitHub API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is 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.

Search Issues and Pull Requests on GitHub
Description:Find issues by state and keyword.
Version:0.0.15
Key:github-search-issues-and-pull-requests

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
    }
  },
}

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
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
orderstringSelect 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.

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.

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.