GitLab modules

Adobe Workfront Fusion requires an Adobe Workfront Fusion license in addition to an Adobe Workfront license.

In an Adobe Workfront Fusion scenario, you can automate workflows that use GitLab, as well as connect it to multiple third-party applications and services.

NOTE
This article expects some familiarity with API documentation, and of GitLab functionality in general.

If you need instructions on creating a scenario, see Create a scenario in Adobe Workfront Fusion.

For information about modules, see Modules in Adobe Workfront Fusion.

Access requirements

You must have the following access to use the functionality in this article:

Adobe Workfront plan*
Pro or higher
Adobe Workfront license*
Plan, Work
Adobe Workfront Fusion license**

Current license requirement: No Workfront Fusion license requirement.

Or

Legacy license requirement: Workfront Fusion for Work Automation and Integration

Product

Current product requirement: If you have the Select or Prime Adobe Workfront Plan, your organization must purchase Adobe Workfront Fusion as well as Adobe Workfront to use functionality described in this article. Workfront Fusion is included in the Ultimate Workfront plan.

Or

Legacy product requirement: Your organization must purchase Adobe Workfront Fusion as well as Adobe Workfront to use functionality described in this article.

To find out what plan, license type, or access you have, contact your Workfront administrator.

For information on Adobe Workfront Fusion licenses, see Adobe Workfront Fusion licenses.

Connect GitLab to Workfront Fusion connect-gitlab-to-workfront-fusion

  1. In any Workfront Fusion Gitlab module, click Add next to the connection field.

  2. Configure the following fields:

    table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header
    Connection name Enter a name for the connection.
    GitLab URL Enter the URL of your GitLab instance.
    Access Token

    Enter your Private Token or Personal Access Token.

    For information on locating or creating a personal access token in GitLab, see "Create a personal access token" in Personal access tokens in the GitLab documentation.

  3. Click Continue.

  4. Click Authorize to create the connection and return to the module.

GitLab modules and their fields

When you configure GitLab modules, Workfront Fusion displays the fields listed below. Along with these, additional GitLab fields might display, depending on factors such as your access level in the app or service. A bolded title in a module indicates a required field.

If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another in Adobe Workfront Fusion.

Triggers

Watch build status

This instant trigger module starts a scenario when the status of a build changes.

table 0-row-2 layout-auto html-authored no-header
Webhook

Select the webhook that you want to use for this trigger, or add a new webhook.

To add a new webhook,

  1. Click Add next to the webhook field.

  2. Enter the following:

    • A name for the webhook
    • The connection that you want to use for this webhook
    • The project that you want the webhook to watch for build status changes
  3. Click Save to save the webhook and return to the module.

Watch commit/MR/issue/snippet comments

This instant trigger module starts a scenario when a comment is made on a commit, merge request, issue, or code snippet.

table 0-row-2 layout-auto html-authored no-header
Webhook

Select the webhook that you want to use for this trigger, or add a new webhook.

To add a new webhook,

  1. Click Add next to the webhook field.

  2. Enter the following:

    • A name for the webhook
    • The connection that you want to use for this webhook
    • The project that you want the webhook to watch for comments
  3. Click Save to save the webhook and return to the module.

Watch commits (pushes)

This instant trigger module starts a scenario when a commit is pushed to a repository. This module does not start a scenario when a tag is pushed.

table 0-row-2 layout-auto html-authored no-header
Webhook

Select the webhook that you want to use for this trigger, or add a new webhook.

To add a new webhook,

  1. Click Add next to the webhook field.

  2. Enter the following:

    • A name for the webhook
    • The connection that you want to use for this webhook
    • The project that you want the webhook to watch for commits
  3. Click Save to save the webhook and return to the module.

Watch issue comment

This instant trigger module starts a scenario when a comment is made on an issue.

table 0-row-2 layout-auto html-authored no-header
Webhook

Select the webhook that you want to use for this trigger, or add a new webhook.

To add a new webhook,

  1. Click Add next to the webhook field.

  2. Enter the following:

    • A name for the webhook
    • The connection that you want to use for this webhook
    • The project that you want the webhook to watch for issue comments
  3. Click Save to save the webhook and return to the module.

Watch issues

This instant trigger module starts a scenario when an issue is created or when an existing issue is updated, closed, or reopened.

table 0-row-2 layout-auto html-authored no-header
Webhook

Select the webhook that you want to use for this trigger, or add a new webhook.

To add a new webhook,

  1. Click Add next to the webhook field.

  2. Enter the following:

    • A name for the webhook
    • The connection that you want to use for this webhook
    • The project that you want the webhook to watch for issues
  3. Click Save to save the webhook and return to the module.

Watch merge requests

This instant trigger module starts a scenario when one of the following occurs:

  • A new merge request is created
  • An existing merge request is updated, merged, or closed
  • A commit is added in the source branch
table 0-row-2 layout-auto html-authored no-header
Webhook

Select the webhook that you want to use for this trigger, or add a new webhook.

To add a new webhook,

  1. Click Add next to the webhook field.

  2. Enter the following:

    • A name for the webhook
    • The connection that you want to use for this webhook
    • The project that you want the webhook to watch for merge requests
  3. Click Save to save the webhook and return to the module.

Watch merge request comments

This instant trigger module starts a scenario when a comment is made on a merge request.

table 0-row-2 layout-auto html-authored no-header
Webhook

Select the webhook that you want to use for this trigger, or add a new webhook.

To add a new webhook,

  1. Click Add next to the webhook field.

  2. Enter the following:

    • A name for the webhook
    • The connection that you want to use for this webhook
    • The project that you want the webhook to watch for merge request comments
  3. Click Save to save the webhook and return to the module.

Watch pipeline status

This instant trigger module starts a scenario when the status of a pipeline changes.

table 0-row-2 layout-auto html-authored no-header
Webhook

Select the webhook that you want to use for this trigger, or add a new webhook.

To add a new webhook,

  1. Click Add next to the webhook field.

  2. Enter the following:

    • A name for the webhook
    • The connection that you want to use for this webhook
    • The project that you want the webhook to watch for pipeline status changes
  3. Click Save to save the webhook and return to the module.

Watch projects

This scheduled trigger module starts a scenario when a new project is added, of which the authenticated user is a member.

table 0-row-2 1-row-2 layout-auto html-authored no-header
Connection For instructions about connecting your GitLab account to Workfront Fusion, see Connect GitLab to Workfront Fusion in this article.
Max Results Enter or map the maximum number of records you want the module to watch during each scenario execution cycle.
Watch repository branches

This scheduled trigger module starts a scenario when a new branch is added to a repository.

table 0-row-2 1-row-2 layout-auto html-authored no-header
Connection For instructions about connecting your GitLab account to Workfront Fusion, see Connect GitLab to Workfront Fusion in this article.
Max Results Enter or map the maximum number of records you want the module to watch during each scenario execution cycle.
Watch repository tags

This instant trigger module starts a scenario when a tag is created or deleted in a repository.

table 0-row-2 layout-auto html-authored no-header
Webhook

Select the webhook that you want to use for this trigger, or add a new webhook.

To add a new webhook,

  1. Click Add next to the webhook field.

  2. Enter the following:

    • A name for the webhook
    • The connection that you want to use for this webhook
    • The project that you want the webhook to watch for tags
  3. Click Save to save the webhook and return to the module.

Watch snippet comments

This instant trigger module starts a scenario when a new comment is made on a snippet.

table 0-row-2 layout-auto html-authored no-header
Webhook

Select the webhook that you want to use for this trigger, or add a new webhook.

To add a new webhook,

  1. Click Add next to the webhook field.

  2. Enter the following:

    • A name for the webhook
    • The connection that you want to use for this webhook
    • The project that you want the webhook to watch for comments
  3. Click Save to save the webhook and return to the module.

Watch todos

This scheduled trigger module starts a scenario when a new todo is added. When no filter is applied, the trigger is run when a new pending todo is added.

For information on fields, see Get a list of to dos in the GitLab documentation.

Watch wiki page

This instant trigger module starts a scenario when a wiki page is create or edited.

table 0-row-2 layout-auto html-authored no-header
Webhook

Select the webhook that you want to use for this trigger, or add a new webhook.

To add a new webhook,

  1. Click Add next to the webhook field.

  2. Enter the following:

    • A name for the webhook
    • The connection that you want to use for this webhook
    • The project that you want the webhook to watch for wiki pages
  3. Click Save to save the webhook and return to the module.

Actions

Accept merge request

This action module merges submitted changes with the given merge request.

For information on fields, see Accept merge request in the GitLab documentation.

Cancel a build

This action module cancels a single build of a project.

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 layout-auto html-authored no-header
Connection For instructions about connecting your GitLab account to Workfront Fusion, see Connect GitLab to Workfront Fusion in this article.
Project ID Select or map the project that contains the build you want to cancel.
Build ID Select or map the build that you want to cancel.
Merge commit message Enter or map a commit message for the merge.
Should remove source branch Select whether you want to remove the source branch when the merge is complete.
Merge when build succeeds Select whether to merge the merge request as soon as the build is completed.
SHA If present, then this SHA must match the HEAD of the source branch. If it does not match, the merge fails.
Cancel a pipeline's builds

This action module cancels the builds for a single pipeline.

For information on fields, see Cancel a pipeline’s jobs in the GitLab documentation.

Cancel merge when pipeline succeeds

If a merge request is set to merge when a pipeline succeeds, this action module cancels that action.

For information on fields, see Cancel merge when pipeline succeeds in the GitLab documentation.

Cherry pick a commit

This action module cherry picks a commit to a given branch.

For information on fields, see Cherry pick a commit in the GitLab documentation.

Create a new label

This action module creates a new label for the given repository.

For information on fields, see Create a new label in the GitLab documentation.

Create a new pipeline

This action module creates a new pipeline for the given project.

For information on fields, see Create a new pipeline in the GitLab documentation.

Create a new release

This action module adds release notes to the existing git tag.

For information on fields, see Create a release in the GitLab documentation.

Create a new tag

This action module creates a new tag in the repository that points to the supplied ref.

For information on fields, see Create a new tag in the GitLab documentation.

Create a todo

This action module creates a todo for the current user on the selected issue. The current user is the user identified by the credentials on the connection used for this module.

For information on fields, see Create a to do in the GitLab documentation.

Create a todo on a merge request

This action module creates a todo for the current user on the selected merge request. The current user is the user identified by the credentials on the connection used for this module.

For information on fields, see Create a to-do in the GitLab documentation.

Create merge request

This action module creates a new merge request on a project.

For information on fields, see Create merge request in the GitLab documentation.

Create new file in repository

This action module creates a new file in the selected repository.

For information on fields, see Create new file in repository in the GitLab documentation.

Create new issue note

This action module creates an issue note for a single project issue.

For information on fields, see Create new issue note in the GitLab documentation.

Create new merge request note

This action module creates note for a single merge request.

For information on fields, see Create new merge request note in the GitLab documentation.

Create a new milestone

This action module creates a new milestone for a project.

For information on fields, see Create new milestone in the GitLab documentation.

Create new snippet note

This action module creates a new note for a single snippet. Snippet notes are comments users can post to a snippet.

For information on fields, see Create new snippet note in the GitLab documentation.

Create repository branch

This action module creates a single repository branch.

For information on fields, see Create repository branch in the GitLab documentation.

Create build variable

This action module creates a new build variable.

For information on fields, see Create variable in the GitLab documentation.

Delete a merge request

This action module is only for admins and project owners. It deletes the merge request in question

For information on fields, see Delete a merge request in the GitLab documentation.

Delete existing file in repository

This action module deletes an existing file from the repository.

For information on fields, see Delete existing file in repository in the GitLab documentation.

Delete repository branch

This action module deletes a branch from the repository.

For information on fields, see Delete repository branch in the GitLab documentation.

Edit issue

This action module updates an existing project issue. This call is also used to mark an issue as closed.

For information on fields, see Edit issue in the GitLab documentation.

Edit Milestone

This action module updates an existing project milestone.

For information on fields, see Edit milestone in the GitLab documentation.

Erase a build

This action module erases a build of a project (removes job artifacts and job log).

For information on fields, see Erase a job in the GitLab documentation.

Get a list of todos

This search module retrieves a list of to-do items.

For information on fields, see Get a list of to dos in the GitLab documentation.

Get a single build

This action module retrieves a single job of a project.

For information on fields, see Get a single job in the GitLab documentation.

Get a single repository tag

This action module retrieves a specific repository tag determined by its name.

For information on fields, see Get a single repository tag in the GitLab documentation.

Get a specific deployment

This action module retrieves a specific deployment.

For information on fields, see Get a specific deployment in the GitLab documentation.

Get all issues assigned to a single milestone

This search module retrieves all issues assigned to a single project milestone.

For information on fields, see Get all issues assigned to a single milestone in the GitLab documentation.

Get file from repository

This action module retrieves information about a file in the repository like name, size, or content.

For information on fields, see Get file from repository in the GitLab documentation.

Get project users

This search module retrieves the users of the project.

For information on fields, see Get project users in the GitLab documentation.

Get a single issue

This action module retrieves issue details.

table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header
Connection To create a new connection, see Connect GitLab to Workfront Fusion in this article.
Project Select the project that contains the issue you want to retrieve details about.
Issue ID Enter or map the name of the issue you want to retrieve details about.
Get single issue note

This action module retrieves a single note for a specific project issue.

For information on fields, see Get single issue note in the GitLab documentation.

Get single merge request

This action module retrieves information about a single merge request.

For information on fields, see Get single merge request in the GitLab documentation.

Get single merge request changes

This search module retrieves information about the merge request including its files and changes.

For information on fields, see Get single merge request changes in the GitLab documentation.

Get single merge request commits

This action module retrieves a list of merge request commits.

For information on fields, see Get single merge request commits in the GitLab documentation.

Get single merge request note

This action module returns a single note for a given merge request.

For information on fields, see Get single merge request note in the GitLab documentation.

Get a Milestone

This action module retrieves milestone details.

For information on fields, see Get single milestone in the GitLab documentation.

Get single project

This action module retrieves project details.

For information on fields, see Get single project in the GitLab documentation.

Get single repository branch

This action module retrieves repository branch details.

For information on fields, see Get single repository branch in the GitLab documentation.

Get snippet note

This module retrieves a single note for a given snippet.

For information on fields, see Get a single snippet note in the GitLab documentation.

Get the comments of a commit

This search module retrieves comments of a commit in a project.

For information on fields, see Get the comments of a commit in the GitLab documentation.

Get the diff of a commit

This action module gets the diff of a commit in a project.

For information on fields, see Get the diff of a commit in the GitLab documentation.

Keep artifacts

Prevents artifacts from being deleted when expiration is set.

For information on fields, see Keep artifacts in the GitLab documentation.

List all merge request notes

This search module retrieves a list of all notes for a single merge request.

For information on fields, see List all merge request notes in the GitLab documentation.

List all snippet notes

This module gets a list of all notes for a single snippet. Snippet notes are comments users can post to a snippet.

For information on fields, see 🔗 in the GitLab documentation.

List commit builds

This search module returns a list of builds for a specific commit in a project.

table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header
Connection To create a new connection, see Connect GitLab to Workfront Fusion in this article.
Project ID Select the project that contains the commit that you want to list builds for.
Scope To limit the search to build with a specific status, select the status. Leaving this field blank returns all builds of the commit.
List issues

This search module returns all issues by the specified filter settings.

For information on fields, see List issues in the GitLab documentation.

List Issues That Close on Merge

This search module retrieves all the issues that would be closed by merging the provided merge request.

For information on fields, see List issues that will close on merge in the GitLab documentation.

List Labels

This search module retrieves all labels in the project.

For information on fields, see List labels in the GitLab documentation.

List merge requests

This search module retrieves all merge requests by the filter settings.

For information on fields, see List merge requests in the GitLab documentation.

List Owned Projects

This search module retrieves projects where the authenticated user is set as owner.

For information on fields, see List user projects in the GitLab documentation.

List project builds

This search module retrieves a list of builds in a project.

For information on fields, see List project jobs in the GitLab documentation.

List project deployments

This search module retrieves a list of deployments in a project.

For information on fields, see List project deployments in the GitLab documentation.

List project issue notes

This search module retrieves a list of all notes for a single issue.

For information on fields, see List project issue notes in the GitLab documentation.

List project issues

This search module returns all issues in a specified project.

For information on fields, see List project issues in the GitLab documentation.

List project milestones

This search module retrieves all milestones in the project.

For information on fields, see List project milestones in the GitLab documentation.

List project pipelines

This search module retrieves all pipelines for the project.

For information on fields, see List project pipelines in the GitLab documentation.

List project repository tags

This search module retrieves a list of repository tags from a project, sorted by name in reverse alphabetical order.

For information on fields, see List project repository tags in the GitLab documentation.

List project variables

This search module retrieves a list of a project’s variables.

For information on fields, see List project variables in the GitLab documentation.

List projects

This search module retrieves all projects of which the authenticated user is a member.

For information on fields, see List all projects in the GitLab documentation.

List repository branches

This module searches for repository branches by the search term.

For information on fields, see List repository branches in the GitLab documentation.

List repository commits

This search module retrieves a list of repository commits in a project.

For information on fields, see List repository commits in the GitLab documentation.

List repository contributors

This search module retrieves a repository contributors list.

For information on fields, see Contributors in the GitLab documentation.

List repository tree

This search module retrieves a list of repository files and directories in a project.

For information on fields, see List repository tree in the GitLab documentation.

Mark a todo as done

This action module marks a single pending to-do item given by its ID for the current user as done.

For information on fields, see Mark a to do item as done in the GitLab documentation.

Modify existing issue note

Modifies an existing note of an issue.

For information on fields, see Modify existing issue note in the GitLab documentation.

Modify existing merge request note

Modifies the existing note of a merge request.

For information on fields, see Modify existing merge request note in the GitLab documentation.

Modify existing snippet note

This action module modifies an existing note of a snippet.

For information on fields, see Modify existing snippet note in the GitLab documentation.

New issue

This action module creates a new project issue.

For information on fields, see New issue in the GitLab documentation.

Play a build

This action module triggers a manual action to start a job.

For information on fields, see Play a job in the GitLab documentation.

Post comment to commit

This action module adds a comment to a commit.

For information on fields, see Post comment to commit in the GitLab documentation.

Remove variable

This action module removes a project’s variable.

For information on fields, see Remove variable in the GitLab documentation.

Retry a build

This action module retries a single build in a commit.

table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header
Connection To create a new connection, see Connect GitLab to Workfront Fusion in this article.
Project ID Select the project that contains the build you want to retry.
Build ID Select the build that you want to retry.
Retry Failed Jobs in a Pipeline

This action module retries failed builds in a pipeline.

For information on fields, see Retry jobs in a pipeline in the GitLab documentation.

Get a Variable

This module retrieves details of a project’s specific variable.

For information on fields, see Show variable details in the GitLab documentation.

Update a release

This action module updates a release.

For information on fields, see Update a release in the GitLab documentation.

Update merge request

This action module updates an existing merge request. You can change the target branch, title, or even close the MR.

For information on fields, see Update merge request in the GitLab documentation.

Update a Variable

This action module updates a project’s variable.

For information on fields, see Update variable in the GitLab documentation.

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43