← Gitlab + Data Stores integrations

Add or update multiple records with Data Stores API on New Commit (Instant) from Gitlab API

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

Trigger workflow on
New Commit (Instant) from the Gitlab API
Next, do this
Add or update multiple records with the Data Stores API
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

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.

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

Details

This integration uses pre-built, open source 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

Description:Emit new event when a new commit is pushed to a branch
Version:0.1.1
Key:gitlab-new-commit

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.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);
      });
    },
  },
};

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

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

Description:Add or update multiple records to your [Pipedream Data Store](https://pipedream.com/data-stores/).
Version:0.0.5
Key:data_stores-add-update-multiple-records

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-add-update-multiple-records",
  name: "Add or update multiple records",
  description: "Add or update multiple records to your [Pipedream Data Store](https://pipedream.com/data-stores/).",
  version: "0.0.5",
  type: "action",
  props: {
    app,
    dataStore: {
      propDefinition: [
        app,
        "dataStore",
      ],
    },
    data: {
      label: "Data",
      type: "object",
      description: "Enter data you'd like to add as key-value pairs, or reference an object from a previous step using a custom expression (e.g., `{{steps.data.$return_value}}`). Note that any keys that are duplicated will get overwritten with the last value entered (so `[{jerry: \"constanza\", jerry: \"seinfeld\"}]` will get stored as `[{jerry: \"seinfeld\"}]`).",
    },
  },
  methods: {
    /**
     * Tries to convert a string to a JSON object or a primitive value.
     * @param {any} value Value to be converted
     * @returns The converted value
     */
    convertString(value) {
      // If type is already primitive non string, return it
      const primitives = [
        "boolean",
        "number",
      ];
      if (primitives.includes(typeof value)) {
        return value;
      }

      // Tries to convert string to possible other primitive types
      if (typeof value === "string") {
        // Convert boolean
        if (value.toLowerCase() === "true") {
          return true;
        }
        if (value.toLowerCase() === "false") {
          return false;
        }

        // Convert number
        if (!isNaN(value)) {
          return parseFloat(value);
        }
      }

      return this.app.evaluate(value);
    },
    /**
     * Add all the key-value pairs in the map object to be used in the data store
     * @param {*} data Data to be parsed
     * @param {Map} map Hashmap to be updated
     */
    populateHashMapOfData(data, map) {
      if (!Array.isArray(data) && typeof(data) === "object") {
        Object.keys(data).forEach((key) => map[key] = this.convertString(data[key]));
        return;
      }

      if (Array.isArray(data)) {
        for (const item of data) {
          this.populateHashMapOfData(item, map);
        }
      }
    },
    getHashMapOfData(data) {
      const map = {};
      this.populateHashMapOfData(data, map);
      return map;
    },
  },
  async run({ $ }) {
    if (typeof this.data === "string") {
      this.data = this.app.evaluate(this.data);
    }
    const map = this.getHashMapOfData(this.data);
    const keys = Object.keys(map);
    const promises = Object.keys(map).map((key) => this.dataStore.set(key, map[key]));
    await Promise.all(promises);
    if (keys.length === 0) {
      $.export("$summary", "No data was added to the data store.");
    } else {
      // eslint-disable-next-line multiline-ternary
      $.export("$summary", `Successfully added or updated ${keys.length} record${keys.length === 1 ? "" : "s"}`);
    }
    return map;
  },
};

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.

LabelPropTypeDescription
Data StoresappappThis component uses the Data Stores app.
Data StoredataStoredata_store

Select an existing Data Store or create a new one.

Datadataobject

Enter data you'd like to add as key-value pairs, or reference an object from a previous step using a custom expression (e.g., {{steps.data.$return_value}}). Note that any keys that are duplicated will get overwritten with the last value entered (so [{jerry: "constanza", jerry: "seinfeld"}] will get stored as [{jerry: "seinfeld"}]).

Action Authentication

The Data Stores API does not require authentication.

About Data Stores

Use Pipedream Data Stores to manage state throughout your workflows.

More Ways to Connect Data Stores + Gitlab

Add or update multiple records with Data Stores API on New Review Request (Instant) from Gitlab API
Gitlab + Data Stores
 
Try it
Add or update multiple records with Data Stores API on New Milestone from Gitlab API
Gitlab + Data Stores
 
Try it
Add or update multiple records with Data Stores API on New Project from Gitlab API
Gitlab + Data Stores
 
Try it
Add or update multiple records with Data Stores API on New Merge Request (Instant) from Gitlab API
Gitlab + Data Stores
 
Try it
Add or update multiple records with Data Stores API on New Commit Comment (Instant) from Gitlab API
Gitlab + Data Stores
 
Try it
New Commit (Instant) from the Gitlab API

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

 
Try it
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
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