git

Documentation

Overview

Package git extracts deterministic commit-mutation traces from Git repos.

Index

• func CanonicalRepoIDFromURL(repoURL string) (string, error)
• func CloneForReplay(ctx context.Context, repoURL, baseDir string) (string, error)
• func ClonePathForURL(baseDir, repoURL string) (string, error)
• type Source
  • func (s Source) CommitCount(ctx context.Context) (int, error)
  • func (s Source) Walk(ctx context.Context, fn func(replay.CommitMutation) error) error

Functions

func CanonicalRepoIDFromURL

func CanonicalRepoIDFromURL(repoURL string) (string, error)

CanonicalRepoIDFromURL derives the evaluation repository identity from a GitHub HTTPS repository URL.

func CloneForReplay

func CloneForReplay(ctx context.Context, repoURL, baseDir string) (string, error)

CloneForReplay creates a fresh managed clone for repoURL under baseDir.

func ClonePathForURL

func ClonePathForURL(baseDir, repoURL string) (string, error)

ClonePathForURL returns the local clone path for a GitHub HTTPS repository under baseDir.

Types

type Source

type Source struct {
	RepoURL      string
	RepoPath     string
	CloneBaseDir string
	Ref          string
	Limit        int
	FirstParent  bool
}

Source streams Git object commit snapshots as replay.CommitMutation values.

func (Source) CommitCount

func (s Source) CommitCount(ctx context.Context) (int, error)

CommitCount returns the number of commits Source.Walk would visit after applying ref, first-parent, and limit settings.

func (Source) Walk

func (s Source) Walk(ctx context.Context, fn func(replay.CommitMutation) error) error

Walk visits commits in chronological replay order.