← Gitlab

New Commit (Instant) from Gitlab API

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

Trigger workflow on
New Commit (Instant) from the Gitlab API
Next, do this
Connect to 900+ 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 (Instant) with Gitlab API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the New Commit (Instant) trigger
    1. Connect your Gitlab account
    2. Select a Project ID
    3. Optional- Select a Branch Name
  2. Add steps to connect to 900+ 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

Integrations

Send Message with Discord Webhook API on New Commit (Instant) from Gitlab API
Gitlab + Discord Webhook
 
Try it
Add Multiple Rows with Google Sheets API on New Commit (Instant) from Gitlab API
Gitlab + Google Sheets
 
Try it
Get Film with SWAPI API on New Commit (Instant) from Gitlab API
Gitlab + SWAPI - Star Wars
 
Try it
Create Multiple Records with Airtable API on New Commit (Instant) from Gitlab API
Gitlab + Airtable
 
Try it
Custom Request with HTTP / Webhook API on New Commit (Instant) from Gitlab API
Gitlab + HTTP / Webhook
 
Try it

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 (Instant) on Gitlab
Description:Emit new event when a new commit is pushed to a branch
Version:0.1.1
Key:gitlab-new-commit

Code

import gitlab from "../../gitlab.app.mjs";
import base from "../common/base.mjs";
import { eventTypes } from "../common/hook-events.mjs";

export default {
  ...base,
  key: "gitlab-new-commit",
  name: "New Commit (Instant)",
  description: "Emit new event when a new commit is pushed to a branch",
  version: "0.1.1",
  dedupe: "unique",
  type: "source",
  props: {
    ...base.props,
    refName: {
      propDefinition: [
        gitlab,
        "branch",
        (c) => ({
          projectId: c.projectId,
        }),
      ],
      optional: true,
    },
  },
  hooks: {
    ...base.hooks,
    async activate() {
      await this.activateHook(eventTypes.PUSH_EVENT);
    },
  },
  methods: {
    ...base.methods,
    isEventForThisBranch(branch) {
      return !this.refName || branch === this.refName;
    },
    generateMeta(commit) {
      const {
        id,
        message,
        shortId,
        committedDate,
      } = commit;
      return {
        id,
        summary: `New commit: ${message} (${shortId})`,
        ts: +new Date(committedDate),
      };
    },
    async emitEvent(event) {
      const refName = event.ref.split("refs/heads/").pop();
      if (!this.isEventForThisBranch(refName)) {
        return;
      }

      // Gitlab "push events" are only provisioned with at most
      // 20 commit objects (which also lack information when compared
      // to the Commits API). The amount of new commits is specified
      // in a separate variable called `total_commits_count`, which
      // we'll use to keep track of the commits that we need to emit
      // downstream.
      // See https://gitlab.com/help/user/project/integrations/webhooks#push-events
      const { total_commits_count: totalCommitsCount } = event;
      if (totalCommitsCount <= 0) return;

      const commits = await this.gitlab.listCommits(this.projectId, {
        refName,
        max: Math.min(50, totalCommitsCount),
      });

      // We need to collect all the relevant commits, sort
      // them in reverse order (since the Gitlab API sorts them
      // from most to least recent) and emit an event for each
      // one of them.
      commits.reverse().forEach((commit) => {
        const meta = this.generateMeta(commit);
        this.$emit(commit, meta);
      });
    },
  },
};

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
GitlabgitlabappThis component uses the Gitlab app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
N/Ahttp$.interface.httpThis component uses $.interface.http to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the run() method of the component.
Project IDprojectIdintegerSelect a value from the drop down menu.
Branch NamerefNamestringSelect a value from the drop down menu.

Authentication

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

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

apiread_userread_repositorywrite_repositoryread_registrysudoopenidprofileemail

About Gitlab

Project planning and source code management

More Ways to Use Gitlab

Triggers

New Branch (Instant) from the Gitlab API

Emit new event when a new branch is created

 
Try it
New Project from the Gitlab API

Emit new event when a project (i.e. repository) is created

 
Try it
New Audit Event (Instant) from the Gitlab API

Emit new event when a new audit event is created

 
Try it
New Commit Comment (Instant) from the Gitlab API

Emit new event when a commit receives a comment

 
Try it
New Issue (Instant) from the Gitlab API

Emit new event when an issue is created in a project

 
Try it

Actions

Create Branch with the Gitlab API

Create a new branch in the repository. See docs

 
Try it
Create Epic with the Gitlab API

Creates a new epic. See docs

 
Try it
Create issue with the Gitlab API

Creates a new issue. See docs

 
Try it
Edit Issue with the Gitlab API

Updates an existing project issue. See docs

 
Try it
Get Issue with the Gitlab API

Gets a single issue from repository. See docs

 
Try it