ALM Octane plugin for Microsoft Team Foundation Server CI

Project status:

Latest release branch status:

This plugin integrates ALM Octane with TFS, enabling ALM Octane to display TFS build pipelines and track build and test run results.

Installation instructions

1. Download latest msi release setup from : releases
2. Run setup.exe
3. Configure all relevant fields following the Configure the setup guide

Configuring the TFS ci plugin to connect to ALM Octane

Before you configure the connection:

1. Ask the ALM Octane shared space admin for an API access Client ID and Client secret. The plugin uses these for authentication when communicating with ALM Octane. The access keys must be assigned the CI/CD Integration role in all relevant workspaces. For details, see Set up API access for integration.
2. To enable the TFS server to communicate with ALM Octane, make sure the server can access the Internet. If your network requires a proxy to connect to the Internet, setup the required proxy configuration.

Configure the setup

During the msi setup Enter the following information in the relevant fields:

Installation folder: C:\Program Files\Microsoft Team Foundation Server 15.0\Application Tier\TFSJobAgent\Plugins\

  This folder is provided by default and should be changed only if TFS installation path is different from the default

Location: http://myServer.myCompany.com:8081/ui/?p=1002 where 1002 is your shared space id and 8081 is the ALM Octane port service port

Client ID/Secret: Ask the ALM Octane shared space admin for an API access Client ID and Client secret. The plugin uses these for authentication when communicating with ALM Octane

Client ID/Secret: Ask the ALM Octane shared space admin for an API access Client ID and Client secret. The plugin uses these for authentication when communicating with ALM Octane

PAT (TFS Personal access token): The token should be configured by TFS admin (see PAT )

After the connection is set up, open ALM Octane, define a CI server and create pipelines. For details, see Integrate with your CI server in the ALM Octane Help.

Administer the plugin

There are several rest api operations that can be performed to monitor plugin health. The rest api is available only from the localhost address.

Plugin logs are located in C:\Users\Public\Documents\OctaneTfsPlugin\logs

Relevent links

• Download the most recent build version of the plugin at appveyor

Limitations

• Currently the plugin does not support commits in ALM Octane in TFS 2015 version with TFVC

Contribute to the TFS plugin

• Contributions of code are always welcome!
• Follow the standard GIT workflow: Fork, Code, Commit, Push and start a Pull request
• Each pull request will be tested, pass static code analysis and code review results.
• All efforts will be made to expedite this process.

Guidelines

• Document your code – it enables others to continue the great work you did on the code and update it.

Feel free to contact us on any question related to contributions - octane.ci.plugins@gmail.com