source

package

v0.2.8 Latest Latest Go to latest Published: Jul 22, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/sholdee/drydock

Links

Open Source Insights

Documentation ¶

Overview ¶

Package source resolves Git repository references through explicit local maps or declared cache-backed acquisition.

Index ¶

func CanonicalGitURLKey(raw string) string
func DefaultGitCacheDir() (string, error)
func GitCacheKey(repoURL, revision string) string
func GitRevisionCandidates(revision string) []plumbing.Revision
func IsCommitSHA(rev string) bool
func IsDefaultRevision(rev string) bool
func NormalizeURL(input string) string
func RedactGitCredentialError(message string, credentials GitCredentials) string
func RedactURL(input string) string
func ResolveGitRevision(repo *git.Repository, revision string) (*plumbing.Hash, error)
type DefaultGitAcquirer
- func (DefaultGitAcquirer) Acquire(ctx context.Context, request GitRequest, opts GitOptions) (GitResult, error)
type GitAcquirer
type GitCredentials
type GitOptions
type GitRequest
type GitResult
type Options
type RepoMap
type ResolvedRepository
type Resolver
- func NewResolver(opts Options) *Resolver
- func (r *Resolver) MappedPath(repoURL string) (string, bool)
- func (r *Resolver) Resolve(repoURL, revision string) (ResolvedRepository, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CanonicalGitURLKey ¶ added in v0.2.5

func CanonicalGitURLKey(raw string) string

CanonicalGitURLKey reduces a git URL to "host/path" for self-repo matching ONLY: lowercase host, strip scheme/userinfo/port, convert scp-style git@host:x/y, trim ".git" and trailing slashes. It must never feed GitCacheKey, NormalizeURL consumers, or render-cache locators — it is a matching key, not a cache key (changing NormalizeURL would invalidate persistent caches; NormalizeURL stays untouched).

func DefaultGitCacheDir ¶

func DefaultGitCacheDir() (string, error)

func GitCacheKey ¶

func GitCacheKey(repoURL, revision string) string

func GitRevisionCandidates ¶

func GitRevisionCandidates(revision string) []plumbing.Revision

func IsCommitSHA ¶ added in v0.2.5

func IsCommitSHA(rev string) bool

IsCommitSHA reports whether rev is a full 40- or 64-char lowercase-hex id.

func IsDefaultRevision ¶ added in v0.2.5

func IsDefaultRevision(rev string) bool

IsDefaultRevision reports whether rev requests the default branch.

func NormalizeURL ¶

func NormalizeURL(input string) string

func RedactGitCredentialError ¶

func RedactGitCredentialError(message string, credentials GitCredentials) string

func RedactURL ¶

func RedactURL(input string) string

func ResolveGitRevision ¶

func ResolveGitRevision(repo *git.Repository, revision string) (*plumbing.Hash, error)

Types ¶

type DefaultGitAcquirer ¶

type DefaultGitAcquirer struct{}

func (DefaultGitAcquirer) Acquire ¶

func (DefaultGitAcquirer) Acquire(ctx context.Context, request GitRequest, opts GitOptions) (GitResult, error)

type GitAcquirer ¶

type GitAcquirer interface {
	Acquire(ctx context.Context, request GitRequest, opts GitOptions) (GitResult, error)
}

type GitCredentials ¶

type GitCredentials struct {
	Username          string
	Password          string
	BearerToken       string
	SSHPrivateKeyPath string
	SSHPrivateKey     string
	SSHPassphrase     string
	SSHKnownHostsPath string
}

type GitOptions ¶

type GitOptions struct {
	AllowNetwork bool
	CacheDir     string
	Refresh      bool
	Credentials  GitCredentials
}

type GitRequest ¶

type GitRequest struct {
	URL      string
	Revision string
}

type GitResult ¶

type GitResult struct {
	Path      string
	Revision  string
	FromCache bool
	Network   bool
}

type Options ¶

type Options struct {
	RepoMaps []RepoMap
	Offline  bool
}

type RepoMap ¶

type RepoMap struct {
	URL  string
	Path string
}

type ResolvedRepository ¶

type ResolvedRepository struct {
	URL              string
	NormalizedURL    string
	DeclaredRevision string
	LocalPath        string
	Mapped           bool
	Network          bool
}

type Resolver ¶

type Resolver struct {
	// contains filtered or unexported fields
}

func NewResolver ¶

func NewResolver(opts Options) *Resolver

func (*Resolver) MappedPath ¶

func (r *Resolver) MappedPath(repoURL string) (string, bool)

func (*Resolver) Resolve ¶

func (r *Resolver) Resolve(repoURL, revision string) (ResolvedRepository, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL