Skip to main content
System StatusContact Support
VersionOne Community

Configuring the TeamForge Plugin

If you have TeamForge, use the TeamForge plugin, which is maintained by Continuum, to add comments to TeamForge artifacts, update artifacts, change the status of artifacts, create or delete Git branches, create Git tags and list repositories in a TeamForge project.

Overview

If you have TeamForge, use the TeamForge plugin, which is maintained by Continuum, to add comments to TeamForge artifacts, update artifacts, change the status of artifacts, create or delete Git branches, create Git tags and list repositories in a TeamForge project.

Configuration

  1. Select Plugins from the Administration menu (cogwheel icon) and select  TeamForge from the list of plugins available. 
  2. Click Add and enter the following information:
    • Name: Type a name for the TeamForge instance. 
    • User and Password: Type the username and password that should be used to log on to TeamForge. 
    • URL: Type the URL of the TeamForge instance. 
    • 'Improve' Tracker Types: A comma-separated list of trackers such as Epics, Stories and CRUS (Customer Requested User Stories).
    • 'Maintain' Tracker Types: A comma-separated list if trackers such as Defects and CRIs (Customer Reported Issues). 
  3. Click Test Connection and make sure you are able to connect to the TeamForge instance successfully.
  4. Repeat steps 2 and 3 to add more instances.

Using the TeamForge Plugin

Once one or more TeamForge instances have been set up, you can set up pipelines that use the TeamForge plugin. You can either create a new Stage and add a step that uses the TeamForge plugin or add the TeamForge plugin to an existing Stage.

Functions

There are eight functions available with the TeamForge plugin:

teamforgeplugin1.png

Add Comment to Artifacts

Use this function to add a comment to a TeamForge artifact. 

Properties

  • Comment (required): Type a comment to add to the TeamForge artifact. 
  • TeamForge Instance Name (optional): Type the TeamForge instance name. Leave it blank to connect to the default TeamForge instance. 
  • TeamForge Artifact ID (optional): Type the TeamForge artifact ID. Leave it blank to post the comment to all the workitems associated with the Pipeline instance. 

Change Artifact Status

Use this function to change the status of an artifact. 

Properties

  • TeamForge Instance Name (optional): Type the TeamForge instance name. Leave it blank to connect to the default TeamForge instance. 
  • TeamForge Artifact ID (optional): Type the TeamForge artifact ID. Leave it blank to change the status of all the workitems associated with the Pipeline instance. 
  • Folder Type (optional): Type the name of the tracker, the artifacts of which would go through a status transition. Leave blank to change the status of all matching artifacts. 
  • New Status (required): Type the name of the status that the artifact would transition to.
  • Result Key (optional): A workspace key that receives the list of artifacts that changed status. 

Update Artifact

Use this function to update an artifact's field with a new value. 

Properties

  • TeamForge Instance Name (optional): Type the TeamForge instance name. Leave it blank to connect to the default TeamForge instance. 
  • TeamForge Artifact ID (optional): Type the TeamForge artifact ID. Leave it blank to update all the workitems associated with the Pipeline instance. 
  • Folder Type (optional): Type the name of the tracker, the artifacts of which would have the field value updated. Leave blank to update all matching artifacts. 
  • Field Name (required): Type the name of the field to update. 
  • Field Value (required): Type a new value for the field.
  • Result Key (optional): A workspace key that receives the field and its new value.

Get Artifact

Use this function to get the artifact details from TeamForge and update the Pipeline's workspace. 

Properties

  • TeamForge Instance Name (optional): Type the TeamForge instance name. Leave it blank to connect to the default TeamForge instance. 
  • TeamForge Artifact ID (required): Type the TeamForge artifact ID.
  • Result Key (optional): A workspace key that receives the artifacts' data. 

List Repositories

Use this function to fetch the list of repositories in a given TeamForge project. 

Properties

  • TeamForge Instance Name (optional): Type the TeamForge instance name. Leave it blank to connect to the default TeamForge instance. 
  • TeamForge Project ID (required): Type the TeamForge project ID.
  • Result Key (optional): A workspace key that receives the list of repositories.

Create Git Branch

Use this function to create a new branch in a given Git repository. 

Properties

  • TeamForge Instance Name (optional): Type the TeamForge instance name. Leave it blank to connect to the default TeamForge instance. 
  • TeamForge Git Repo ID (required): Type the ID of the Git repository where the new branch would be created. 
  • Source Version (required): Type the source revision (or branch name) to create the new branch from. 
  • Branch (required): Type the new branch name. 

Delete Git Branch

Use this function to delete a Git branch from a TeamForge Git repository. 

Properties

  • TeamForge Instance Name (optional): Type the TeamForge instance name. Leave it blank to connect to the default TeamForge instance. 
  • TeamForge Git Repo ID (required): Type the ID of the Git repository that has the branch to be deleted. 
  • Branch (required): Type the name of the branch to be deleted. 

Create Git Tag

Use this function to create a tag in a TeamForge Git repository. 

Properties

  • TeamForge Instance Name (optional): Type the TeamForge instance name. Leave it blank to connect to the default TeamForge instance. 
  • TeamForge Git Repo ID (required): Type the ID of the Git repository where the new tag would be created. 
  • Source Version (required): Type the source revision to create the new tag. 
  • Tag (required): Type the new tag name. 
  • Message (optional): Type a message for tag creation. 
  • Notes (optional): Notes about the new tag. 
  • Was this article helpful?