Get Reviewers - Pipedream

import github from "../../github.app.mjs"; import asyncProps from "../common/asyncProps.mjs"; import constants from "../common/constants.mjs"; export default { key: "github-get-reviewers", name: "Get Reviewers", description: "Get reviewers for a PR ([see documentation](https://docs.github.com/en/rest/pulls/reviews#list-reviews-for-a-pull-request)) or Commit SHA ([see documentation](https://docs.github.com/en/rest/commits/commits#list-pull-requests-associated-with-a-commit)).", version: "0.1.0", type: "action", props: { github, repoFullname: { propDefinition: [ github, "repoFullname", ], }, prOrCommit: { type: "string", label: "PR or Commit", description: "Whether to get reviewers for a [pull request](https://docs.github.com/en/rest/pulls/reviews#list-reviews-for-a-pull-request) or a [commit SHA](https://docs.github.com/en/rest/commits/commits#list-pull-requests-associated-with-a-commit).", options: [ "Pull Request", "Commit SHA", ], reloadProps: true, }, reviewStates: { type: "string[]", label: "Review States", description: "Filter by these review states", options: constants.PULL_REQUEST_STATES, optional: true, }, }, async additionalProps() { return this.prOrCommit === "Pull Request" ? { pullNumber: asyncProps.pullNumber, } : { commitSha: { type: "string", label: "Commit SHA", description: "A commit SHA to get reviewers for", }, }; }, methods: { getReviewers(reviews) { const reviewers = reviews .filter((review) => { if (this.reviewStates?.length) { return this.reviewStates.includes(review.state); // user-defined states } return true; // default states: all }) .map((review) => review.user.login); return this.uniqueReviewers(reviewers); }, uniqueReviewers(reviewers) { return [ ...new Set(reviewers), ]; }, }, async run({ $ }) { let pullNumber = this.pullNumber; if (this.commitSha) { const pr = await this.github.getPullRequestForCommit({ repoFullname: this.repoFullname, sha: this.commitSha, }); if (!pr?.number) { $.export("$summary", "No PR associated with this commit"); return; } pullNumber = pr.number; } const reviews = await this.github.getReviewsForPullRequest({ repoFullname: this.repoFullname, pullNumber, }); const reviewers = this.getReviewers(reviews); $.export("$summary", "Successfully retrieved reviewers"); return reviewers; }, };

Label	Prop	Type	Description
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
PR or Commit	`prOrCommit`	`string`	Select a value from the drop down menu:`Pull RequestCommit SHA`
Review States	`reviewStates`	`string[]`	Select a value from the drop down menu:`APPROVEDCHANGES_REQUESTEDCOMMENTEDDISMISSEDPENDING`

Label

Prop

Type

Description

GitHub

github

app

This component uses the GitHub app.

Repository

repoFullname

string

Select a value from the drop down menu.

PR or Commit

prOrCommit

string

Select a value from the drop down menu:Pull RequestCommit SHA

Review States

reviewStates

string[]

Select a value from the drop down menu:APPROVEDCHANGES_REQUESTEDCOMMENTEDDISMISSEDPENDING

More Ways to Use GitHub#

Triggers#

New Branch Created from the GitHub API

Emit new event when a branch is created.

Try it

New Card in Column (Classic Projects) from the GitHub API

Emit new event when a (classic) project card is created or moved to a specific column. For Projects V2 use New Issue with Status trigger. More information here

Try it

New Collaborator from the GitHub API

Emit new event when a collaborator is added

Try it

New Commit from the GitHub API

Emit new event when commits are pushed to a branch

Try it

New Commit Comment from the GitHub API

Emit new event when a commit comment is created

Try it