← GitHub

New Commit from GitHub API

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

Trigger workflow on
New Commit from the GitHub API
Next, do this
Connect to 800+ APIs using code and no-code building blocks
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Trigger a workflow on New Commit with GitHub API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the New Commit trigger
    1. Connect your GitHub account
    2. Configure timer
    3. Select a Repo
    4. Optional- Select a Branch
  2. Add steps to connect to 800+ APIs using code and no-code building blocks
  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.

New Commit on GitHub
Description:Emit new events on new commits to a repo or branch
Version:0.0.5
Key:github-new-commit

Code

const github = require("../../github.app.js");
const common = require("../common-polling.js");

module.exports = {
  ...common,
  key: "github-new-commit",
  name: "New Commit",
  description: "Emit new events on new commits to a repo or branch",
  version: "0.0.5",
  type: "source",
  props: {
    ...common.props,
    repoFullName: {
      propDefinition: [
        github,
        "repoFullName",
      ],
    },
    branch: {
      propDefinition: [
        github,
        "branch",
        (c) => ({
          repoFullName: c.repoFullName,
        }),
      ],
      description:
        "Branch to monitor for new commits. If no branch is selected, the repository’s default branch will be used (usually master).",
    },
  },
  dedupe: "last",
  methods: {
    generateMeta(data) {
      const ts = new Date(data.commit.author.date).getTime();
      return {
        id: data.sha,
        summary: data.commit.message,
        ts,
      };
    },
  },
  async run() {
    const since = this.db.get("since");
    const firstRun = this.db.get("firstRun") ?? true;

    const config = {
      repoFullName: this.repoFullName,
      sha: this.branch,
      since,
    };
    const commits = await this.github.getCommits(config);
    const commitsToEmit = firstRun
      ? commits.slice(0, 10)
      : commits;

    let maxDate = since;
    for (const commit of commitsToEmit) {
      if (!maxDate || new Date(commit.commit.author.date) > new Date(maxDate)) {
        maxDate = commit.commit.author.date;
      }
      const meta = this.generateMeta(commit);
      this.$emit(commit, meta);
    }

    if (maxDate !== since) {
      this.db.set("since", maxDate);
    }

    if (firstRun) {
      this.db.set("firstRun", false);
    }
  },
};

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.
timer$.interface.timer
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
ReporepoFullNamestringSelect a value from the drop down menu.
BranchbranchstringSelect a value from the drop down menu.

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.