Get all records with Data Stores API on New Commit (Instant) from Gitlab API

Pipedream makes it easy to connect APIs for Data Stores, Gitlab and 1,600+ other apps remarkably fast.

Trigger workflow on

New Commit (Instant) from the Gitlab API

Next, do this

Get all records with the Data Stores API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

Trusted by 750,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Gitlab trigger and Data Stores action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Commit (Instant) trigger
1. Connect your Gitlab account
2. Select a Project ID
3. Optional- Select a Branch Name
Configure the Get all records action
1. Connect your Data Stores account
2. Configure Data Store
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Commit (Instant) on Gitlab

Description:Emit new event when a new commit is pushed to a branch

Version:0.1.2

Key:gitlab-new-commit

View on GitHub

Gitlab Overview#

Gitlab API allows developers to access the functionality of Gitlab. With the
Gitlab API, developers can integrate Gitlab with other applications, create
custom applications, or automate tasks.

Some examples of what you can build using the Gitlab API include:

Automate tasks such as creating and managing repositories
Integrate Gitlab with other applications such as your chat application
Create custom applications on top of Gitlab

Trigger 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.2",
  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, {
        params: {
          ref_name: refName,
          per_page: 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);
      });
    },
  },
};

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

Label	Prop	Type	Description
Gitlab	`gitlab`	`app`	This component uses the Gitlab app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This 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 ID	`projectId`	`integer`	Select a value from the drop down menu.
Branch Name	`refName`	`string`	Select a value from the drop down menu.

Trigger 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

Action#

Get all records on Data Stores

Description:Get all records in your [Pipedream Data Store](https://pipedream.com/data-stores/). The memory consumption of the workflow can be affected, since this action will be exposing, to the workflow, the entire data from the selected datastore.

Version:0.0.2

Key:data_stores-get-all-records

View on GitHub

Data Stores Overview#

With the Data Stores API, you can build applications that:

Store data for later retrieval
Retrieve data from a store
Update data in a store
Delete data from a store

Action Code#

import app from "../../data_stores.app.mjs";

export default {
  key: "data_stores-get-all-records",
  name: "Get all records",
  description: "Get all records in your [Pipedream Data Store](https://pipedream.com/data-stores/). The memory consumption of the workflow can be affected, since this action will be exposing, to the workflow, the entire data from the selected datastore.",
  version: "0.0.2",
  type: "action",
  props: {
    app,
    dataStore: {
      propDefinition: [
        app,
        "dataStore",
      ],
    },
  },
  async run({ $ }) {
    const { dataStore } = this;
    const keys = await dataStore.keys();
    const promises = [];
    for (const key of keys) {
      promises.push(dataStore.get(key));
    }
    const arrData = await Promise.all(promises);
    const objData = {};
    for (let i = 0; i < keys.length; i++) {
      objData[keys[i]] = arrData[i];
    }
    $.export("$summary", `Successfully returned ${keys.length} keys.`);
    return objData;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Data Stores	`app`	`app`	This component uses the Data Stores app.
Data Store	`dataStore`	`data_store`	Select an existing Data Store or create a new one.

Get all records with Data Stores API on New Commit (Instant) from Gitlab API

Pipedream makes it easy to connect APIs for Data Stores, Gitlab and 1,600+ other apps remarkably fast.

Trusted by 750,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-12of1,600+apps by most popular

1
-
12
of
1,600+
apps by most popular