Using Azure DevOps for Private Go Modules

TL;DR

This took a few hours of work to iron out, so figured maybe I’d save someone time.

⚡ Just keep it simple and use SSH

⚡ Use dev.azure.com even if using older project.visualstudio.com to keep things simple.

Modules Support

Unlike GitHub, Azure DevOps has some quirks to deal with, specifically in the odd path handling.

My original goal was to set the default handling to be https support, with the SSH override in git config allowing me to use SSH.

This didn’t work.

  • HTTPS requires _git in the path.
  • SSH will not work with that, and also trims out the org name in the url when git config set based on instructions from Microsoft1.

There is a long-running issue with go get imports of Azure DevOps repositories due to the fact that the HTTPS URL contains a _git segment: 2

Compare the path.

TypePath
HTTPSgo get dev.azure.com/<organization>/<project>/_git/<repo>
⚡ What I used with SSHgo get dev.azure.com/<project>/_git/<repo>
SSHgo get dev.azure.com/<organization>/<project>/<repo>.git

Git Config

Set this in your .profile, .bashrc, or $PROFILE

1
export GOPRIVATE=dev.azure.com

There are two approaches you can take.

One seems focused on allowing other dev.azure.com public projects to be used. I’ve never had that need, so I’m ok with my dev.azure.com references being resolved only to my own organization.

TypeCommandGitConfig
Support All Azure DevOps (Public)git config --global url."[email protected]:v3/<organization>/".insteadOf "https://dev.azure.com/<organization>"[url "[email protected]:v3"]<br/>

insteadOf = https://dev.azure.com
⚡ What I Used for Private Orggit config --global url."[email protected]:v3/<organization>/".insteadOf "https://dev.azure.com/[url "[email protected]:v3/<organization>/"]

insteadOf = https://dev.azure.com/
Organization in Dependency Path
This changes the path for dependencies to not require the organization in the dependency path. Instead, the import path will look like this: import "dev.azure.com/<project>/repo.git/subdirectory"

HTTPS

If you don’t have restrictions on this, then you can do https with the following command to add the token in or use a more complex credential manager based process.

1
git config --global url."https://anythinggoeshere:$AZURE_DEVOPS_TOKEN@dev.azure.com".insteadOf "https://dev.azure.com"

Other References

  • SSH key usage in Azure Pipelines3.
  • Using with docker2

  1. Go get command support in Azure Repos Git ↩︎

  2. Private Go Modules on Azure DevOps ↩︎

  3. Install SSH Key task - Azure Pipelines | Microsoft Docs ↩︎


Webmentions

Likes  (1)
  • Carmen Holme