Golang module path

From wikinotes
Revision as of 00:24, 21 July 2022 by Will (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Module paths are used both to locate, and uniquely identify packages.
Downloading packages is normally performed by a lookup in go index,
but the actual src is hosted using a server/service of your choosing.

Documentation

official docs: vcs-find https://go.dev/ref/mod#vcs-find

Notes

URL suffix

Suffix indicating repository type

# Repos supporting multiple protocols will try each in order.
# ex: https://, git://, git+ssh://
#
#
# Bazaar      .bzr
# Fossil      .fossil
# Git         .git
# Mercurial   .hg
# Subversion  .svn

import "example.com/path/to/repo.git"
import "example.com/path/to/repo.git/sub/directory"

HTTP meta tag

HTTP meta tag

<!--
  Meta tags let you abstract the path of your src.
  You may use a import-prefix that has nothing to do with your URL.

  IMPORT-PREFIX: the name of the package being fetched (ex. example.com/x/foo)"
  VCS:           bzr, fossil, git, hg, svn
  REPO-ROOT:     URL to repo-root (no VCS extension!)
-->
<!--                            IMPORT-PREFIX        VCS   REPO-ROOT                 -->
<meta name="go-import" content="example.org/x/foo    git   git+ssh://repos.org:/repos/foo">

Hosted services

Hosted Services

# github.com
import "github.com/user/your_project"
import "github.com/user/your_project/sub/directory"

# launchpad.net
import "launchpad.net/project"
import "launchpad.net/project/series"
import "launchpad.net/project/series/sub/directory"

# ...

Private modules

You may use private modules, but you'll need to set environment variables to keep them private.

# ignore checksum checks on these packages
GOPRIVATE=*.corp.example.com,rsc.io/private

# alternatively, define your own proxy with your own checksums
GOPROXY=proxy.example.com
GONOPROXY=none

Sample Configurations

golang private modules conf: meta tags, git+ssh, nginx