Edit

Go get command support in Azure Repos Git

  • Article
  • 2 minutes to read

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Go is an open-source programming language, also referred to as Golang. In Go, you can use the get command to download and install packages and dependencies. Azure Repos Git provides support for go get within an Azure Repos Git repository. With go get, you will be able to download packages with their dependencies named by the import paths. You can also use the import key word inside a go file to specify the import path, using the same syntax described in the following sections.

Note

The feature documented in this article requires Azure DevOps Server 2019 Update 1 or later version.

Go get with public projects

If your Azure Repos Git repo is in a public project you can use go get using the web repo url in the following format, and Azure Repos returns the appropriate meta tags so that go get knows the type and location of the repo to retrieve it.

go get dev.azure.com/<organization>/<project>/_git/<repo>

You can also import/get a Go package in a subfolder of a repo by appending the subfolder names, as shown in the following examples.

go get dev.azure.com/<organization>/<project>/_git/<repo>/subfolder1

go get dev.azure.com/<organization>/<project>/_git/<repo>/subfolder1/subfolder2

Go get with private projects

If your Azure DevOps Git repo is private, you can either use SSH or authenticate with a Personal Access Token (PAT) for HTTPS.

Important

To access private Azure Repos Git repositories using go get, you must first set the environment variable GOPRIVATE=dev.azure.com. You can set this environment variable locally before building or running.

SSH

To use SSH with go get, you must have SSH keys set up for Azure DevOps as described in Use SSH Key authentication.

When you have SSH keys set up, add this entry to your .gitconfig file:

[url "git@ssh.dev.azure.com:v3/<organization>/"]
  insteadOf = https://dev.azure.com/<organization>/

With this entry and a specific URL format, you can now use go get.

Note

The .git that follows the repo name and _git are not included because you're using the SSH URL.

go get dev.azure.com/<organization>/<project>/<repo>.git

HTTPS

To use HTTPS with go get, you must create a PAT as described in Authenticate access with personal access tokens. This PAT requires only the Code (read) scope.

After you create the PAT, add this entry to your .gitconfig file:

[url "https://<user>:<token>@dev.azure.com/<organization>/<project>/_git/<repo>"]
    insteadOf = https://dev.azure.com/<organization>/<project>/<repo>

The <user> part can be any non-empty string; we suggest the word pat.

With this entry and a specific URL format, you can now use go get.

Note

Be sure to use .git after the repo name.

go get dev.azure.com/<organization>/<project>/_git/<repo>.git

You can also import/get a Go package in a subfolder of a repo by appending the subfolder names, as shown in the following examples.

go get dev.azure.com/<organization>/<project>/_git/<repo>.git/subfolder1

go get dev.azure.com/<organization>/<project>/_git/<repo>.git/subfolder1/subfolder2