ÃÛ¶¹ÊÓƵ

DocumentationWorkfrontWorkfront Guide

GitHub modules

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

In an ÃÛ¶¹ÊÓƵ Workfront Fusion scenario, you can automate workflows that use GitHub, as well as connect it to multiple third-party applications and services.

Access requirements

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

ÃÛ¶¹ÊÓƵ Workfront plan*
Pro or higher
ÃÛ¶¹ÊÓƵ Workfront license*
Plan, Work
ÃÛ¶¹ÊÓƵ 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 ÃÛ¶¹ÊÓƵ Workfront plan, your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ 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 ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ 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 ÃÛ¶¹ÊÓƵ Workfront Fusion licenses, see ÃÛ¶¹ÊÓƵ Workfront Fusion licenses.

Prerequisites

To use GitHub modules, you must hava a GitHub account.

Connect GitHub to Workfront Fusion

For instructions about connecting your GitHub account to Workfront Fusion, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Fusion - Basic instructions

GitHub modules and their fields.

When you configure GitHub modules, Workfront Fusion displays the fields listed below. Along with these, additional GitHub 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 ÃÛ¶¹ÊÓƵ Workfront Fusion.

Triggers

Watch Issues

This module triggers when a new issue is added or an existing issue is modified.

Connection
For instructions about connecting your GitHub account to Workfront Fusion, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Fusion - Basic instructions.
I want to watch
Select whether you want to watch all repositories, or only one repository.
Repository
If you have chosen to watch issues in only one repository, select the repository that you want to watch.
Maximum number of returned issues
Set the maximum number of results that Workfront Fusion will work with during one cycle.
Watch
Select whether you want to watch for only new issues, or new issues and all changes.
Filter

You can filter the issues you want to watch for by how you are associated with them.

  • All issues
  • Only issues assigned to me
  • Only issues created by me
  • Only issues mentioning me
  • Only issues I'm subscribed to updates for
State
Select whether you want to watch only open issues, or only closed issues.
Labels
Add a tag. The module watches for issues with this tag.

Watch Repositories

This module triggers when a repository is created or modified.

Connection
For instructions about connecting your GitHub account to Workfront Fusion, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Fusion - Basic instructions.
Maximum number of returned repositories
Set the maximum number of results that Workfront Fusion will work with during one cycle.
Watch
Select whether you want to watch for new repositories and all changes, or only new repositories.

Watch Forks

This module triggers when a new fork is created.

Connection
For instructions about connecting your GitHub account to Workfront Fusion, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Fusion - Basic instructions.
Repository
Select the repository that you want to watch for forks.
Maximum number of returned forks
Set the maximum number of results that Workfront Fusion will work with during one cycle.

Watch Comments

This module triggers when a new comment is added or an existing comment is modified.

Connection
For instructions about connecting your GitHub account to Workfront Fusion, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Fusion - Basic instructions.
Repository
Select the repository that you want to watch.
Issue number
If you want to restrict the search by only searching for new comments made on a specific issue, enter the issue number.
Maximum number of returned issues
Set the maximum number of results that Workfront Fusion will work with during one cycle.
Watch
Select whether you want to watch for only new comments, or comments and all changes.

Watch Pull Requests

This module triggers when a new pull request is added or an existing pull request is modified.

Connection
For instructions about connecting your GitHub account to Workfront Fusion, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Fusion - Basic instructions.
Repository
Select the repository that you want to watch.
Maximum number of returned pull requests
Set the maximum number of results that Workfront Fusion will work with during one cycle.
State
Select whether you want to watch only open pull requests, only closed ones, or all pull requests.
Watch
Select whether you want to watch for only new pull requests, or new pull requests and all changes.

Actions

Search for an issue

This module searches for issues that match your search criteria.

Connection
For instructions about connecting your GitHub account to Workfront Fusion, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Fusion - Basic instructions.
Maximum number of returned issues
Set the maximum number of results that Workfront Fusion will work with during one cycle (the number of repetitions per scenario run).
Sort by

Select how you want to sort the results of the search.

  • Best match

  • Date created

  • Date updated

  • Number of comments

Sort direction

Select ascending or descending.

For dates, selecting descending will return the most recent date first.

For number of comments, selecting descending will return the issue with the highest number of comments first.

Query
Enter or map your search query. For a detailed description of search options, see on the GitHub help site.

Create an issue

This module creates a new issue in the selected repository.

Connection
For instructions about connecting your GitHub account to Workfront Fusion, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Fusion - Basic instructions.
Repository
Select the repository that you want to create an issue in.
Assignee
Select the people that you want to assign to the issue. Available assignees include anyone with write permissions to the repository, and organization members with read permissions to the repository.
Milestone
Select the milestone that you want to associate with the new issue.
Labels
Select any labels that you want to apply to the new issue.
Title
Enter or map a title for the new issue.
Body
Enter or map the body of the issue, such as a description or additional information

Update an issue

This module updates an existing GitHub issue.

Connection
For instructions about connecting your GitHub account to Workfront Fusion, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Fusion - Basic instructions.
Repository
Select the repository that you want to update an issue in.
Assignee
Select the people that you want to assign to the issue. Available assignees include anyone with write permissions to the repository and organization members with read permissions to the repository.
Milestone
Select the milestone that you want to associate with the issue.
Labels
Select any labels that you want to apply to the issue.
Number
Enter or map the issue number of the issue you want to update.
State
Select the state that you want to update the issue to.
Title
Enter or map a title for the issue.
Body
Enter or map the body of the issue, such as a description or additional information

Get an issue

This module retrieves details about the specified issue

Connection
For instructions about connecting your GitHub account to Workfront Fusion, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Fusion - Basic instructions.
Repository
Select the repository that contains the issue that you want to retrieve details about.
Number
Enter or map the issue number of the issue that you want to retrieve details about.

Add assignees

This module adds assignees to the specified issue

Connection
For instructions about connecting your GitHub account to Workfront Fusion, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Fusion - Basic instructions.
Repository
Select the repository that contains the issue to which you want to add assignees.
Assignee
Select the people that you want to assign to the issue. Available assignees include anyone with write permissions to the repository and organization members with read permissions to the repository.
Number
Enter or map the issue number of the issue to which you want to add assignees.

Remove assignees

This module removes assignees from the specified issue.

Connection
For instructions about connecting your GitHub account to Workfront Fusion, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Fusion - Basic instructions.
Repository
Select the repository that contains the issue from which you want to remove assignees.
Assignee
Select the people that you want to remove from the issue.
Number
Enter or map the issue number of the issue from which you want to remove assignees.

Add labels to an issue

This module adds labels to an issue. Labels are defined on the repository level, and can only be created by someone with write access to the repository.

Connection
For instructions about connecting your GitHub account to Workfront Fusion, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Fusion - Basic instructions.
Repository
Select the repository that contains the issue to which you want to add labels.
Labels
Select the labels that you want to add to the issue.
Number
Enter or map the issue number of the issue to which you want to add labels.

Remove a label from an issue

This module removes a single label from an issue.

Connection
For instructions about connecting your GitHub account to Workfront Fusion, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Fusion - Basic instructions.
Repository
Select the repository that contains the issue from which you want to remove a label.
Labels
Select the label that you want to remove from the issue.
Number
Enter or map the issue number of the issue from which you want to remove a label.

Create a comment

This module creates a comment on the specified issue.

Connection
For instructions about connecting your GitHub account to Workfront Fusion, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Fusion - Basic instructions.
Repository
Select the repository that contains the issue on which you want to create a comment.
Number
Enter or map the issue number of the issue on which you want to create a comment.
Body
Enter or map the content of the comment.

List comments

This module lists all comments on the specified issue.

Connection
For instructions about connecting your GitHub account to Workfront Fusion, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Fusion - Basic instructions.
Repository
Select the repository that contains the issue from which you want to list comments.
Number
Enter or map the issue number of the issue from which you want to list comments.
Since
The module will return comments created after this date. For a list of supported date formats, see Type coercion in ÃÛ¶¹ÊÓƵ Workfront Fusion.
Maximum number of returned comments
Set the maximum number of results that Workfront Fusion will work with during one cycle.
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43