Octopus Deploy Documentation

Manually install the build task (Not Recommended)

Last updated

If you'd like more control over the build task we've created, you can manually upload it yourself using Microsoft's TFX CLI tool.

This is also the method you'll need to use if you want to install the build task in your on-premises Azure DevOps/TFS instance.

Installing the build task

Clone the repository locally

git clone https://github.com/OctopusDeploy/OctoTFS.git

Install TFX-CLI using npm. You'll obviously need node installed to do this.

npm install -g tfx-cli

If you are using an on-premises TFS instance, authentication can only be performed using Basic authentication. See this page for information on how to enable it for your on-premises server.

When you log in, use --authType basic to authenticate that way. NTLM authentication is coming to the TFX tool soon.

Create a new Personal Access Token (PAT) in Azure DevOps/TFS in the Security tab for your Profile.

Specify All scopes. You can revoke this token as soon as the task is uploaded.

Login to your Visual Studio or Azure DevOps/TFS account using the TFX-CLI tool

 tfx login

Navigate to the cloned folder which is the root of the extension at which point you can install dependencies and build the extension and all associated tasks

npm install
npm run build

Use the TFX-CLI tool to upload the Octopus Create Release task. You will need to point at the dist\tasks\CreateOctopusRelease folder in the cloned repository.

 tfx build tasks upload <path-to-task>

Need support? We're here to help.