New Commit - Pipedream

import common from "../common/common-flex.mjs"; import { getSampleTimerEvent, getSampleWebhookEvent, } from "./common-sample-events.mjs"; export default { ...common, key: "github-new-commit", name: "New Commit", description: "Emit new event when commits are pushed to a branch", version: "1.0.9", type: "source", dedupe: "unique", props: { eventTypeInfo: { type: "alert", alertType: "info", content: "**Note:** one event is emitted for each individual commit, even if they are received at the same time.", }, ...common.props, branch: { propDefinition: [ common.props.github, "branch", (c) => ({ repoFullname: c.repoFullname, }), ], }, }, methods: { ...common.methods, _getLastTimestamp() { return this.db.get("lastTimestamp") ?? Date.now(); }, _setLastTimestamp(value) { this.db.set("lastTimestamp", value); }, getSampleTimerEvent, getSampleWebhookEvent, getWebhookEvents() { return [ "push", ]; }, getSummary(item) { return `New commit: ${item.commit?.message ?? item.message}`; }, async onWebhookTrigger(event) { const { body, headers, } = event; if (body?.ref?.split?.("refs/heads/").pop() === this.branch.split("/").pop()) { body.commits.forEach((commit) => { const { id } = commit; this.emitEvent({ id, headers, item: commit, }); }); } }, async onTimerTrigger() { const { repoFullname } = this; const timestamp = this._getLastTimestamp(); const since = new Date(timestamp).toISOString() .slice(0, -5) + "Z"; const sha = this.branch.split("/").pop(); const items = await this.github.getCommits({ repoFullname, sha, since, }); const savedItems = this._getSavedItems(); const shouldEmit = this.shouldEmit(); items .filter(({ sha }) => !savedItems.includes(sha)) .sort((a, b) => { const dateA = new Date(a.commit.author.date); const dateB = new Date(b.commit.author.date); return dateA - dateB; }) .forEach((item) => { const id = item.sha; if (shouldEmit) { this.emitEvent({ id, item, }); } savedItems.push(id); }); this._setSavedItems(savedItems); this._setLastTimestamp(Date.now()); }, getHttpDocsLink() { return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#push"; }, getTimerDocsLink() { return "https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#list-commits"; }, }, };

Label	Prop	Type	Description
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Branch	`branch`	`string`	Select a value from the drop down menu.

Label

Prop

Type

Description

GitHub

github

app

This component uses the GitHub app.

Repository

repoFullname

string

Select a value from the drop down menu.

N/A

db

$.service.db

This component uses $.service.db to maintain state between executions.

Branch

branch

string

Select a value from the drop down menu.

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 Comment from the GitHub API

Emit new event when a commit comment is created

Try it

New Discussion from the GitHub API

Emit new event when a discussion is created

Try it