gitref

Documentation

Index

• Constants
• func NormalizeRef(ref string) string
• func ParseRepoURL(repo string) (owner, name string, err error)
• type GitHubResolver
  • func NewGitHubResolver() *GitHubResolver
  • func NewGitHubResolverWithClient(client *http.Client) *GitHubResolver
  • func (r *GitHubResolver) Resolve(ctx context.Context, repo, ref string) (string, string, error)
• type Resolver

Constants

const (
	// DefaultNCTRepo is the default NVIDIA Container Toolkit repository.
	DefaultNCTRepo = "https://github.com/NVIDIA/nvidia-container-toolkit.git"
	// DefaultK8sRepo is the default Kubernetes repository.
	DefaultK8sRepo = "https://github.com/kubernetes/kubernetes.git"
)

Functions

func NormalizeRef

func NormalizeRef(ref string) string

NormalizeRef strips refs/ prefix for API calls.

func ParseRepoURL

func ParseRepoURL(repo string) (owner, name string, err error)

ParseRepoURL extracts owner and repo name from a GitHub URL. Handles:

• https://github.com/NVIDIA/nvidia-container-toolkit.git
• git@github.com:NVIDIA/nvidia-container-toolkit.git
• github.com/NVIDIA/nvidia-container-toolkit

Types

type GitHubResolver

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

GitHubResolver resolves refs using GitHub API.

func NewGitHubResolver

func NewGitHubResolver() *GitHubResolver

NewGitHubResolver creates a new GitHubResolver with a default 30s timeout.

func NewGitHubResolverWithClient

func NewGitHubResolverWithClient(client *http.Client) *GitHubResolver

NewGitHubResolverWithClient creates a GitHubResolver with a custom HTTP client.

func (*GitHubResolver) Resolve

func (r *GitHubResolver) Resolve(
	ctx context.Context, repo, ref string,
) (string, string, error)

Resolve handles various ref formats:

• Full SHA: abc123def456789...
• Short SHA: abc123
• Tag: v1.17.3 or refs/tags/v1.17.3
• Branch: main or refs/heads/main
• PR: refs/pull/123/head

type Resolver

type Resolver interface {
	// Resolve returns the full and short commit SHA for a reference.
	Resolve(ctx context.Context, repo, ref string) (fullSHA, shortSHA string, err error)
}

Resolver resolves git references to commit SHAs.