Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Git data fallbacks #1587

Merged
merged 2 commits into from
Oct 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 42 additions & 25 deletions pkg/cli/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,11 @@ func buildCmd() *cobra.Command {
ctx := cmd.Context()
log := clog.FromContext(ctx)

var buildConfigFilePath string
if len(args) > 0 {
buildConfigFilePath = args[0] // e.g. "crane.yaml"
}

if traceFile != "" {
w, err := os.Create(traceFile)
if err != nil {
Expand Down Expand Up @@ -130,17 +135,17 @@ func buildCmd() *cobra.Command {
// Git auto-detection should be "best effort" and not fail the build if it
// fails.
if configFileGitCommit == "" || configFileGitRepoURL == "" {
gs, err := detectGitState(ctx)
gs, err := detectGitState(ctx, buildConfigFilePath)
if err != nil {
log.Warnf("failed to auto-detect git information: %v", err)
} else {
if configFileGitCommit == "" {
configFileGitCommit = gs.commit
}
if configFileGitRepoURL == "" {
// To form e.g. "github.com/wolfi-dev/os"
configFileGitRepoURL = fmt.Sprintf("https://%s/%s/%s", gs.repoHost, gs.repoPathParent, gs.repoName)
}
log.Warnf("failed to auto-detect all git information: %v", err)
}

if configFileGitCommit == "" {
configFileGitCommit = gs.commit
}
if configFileGitRepoURL == "" {
// To form e.g. "github.com/wolfi-dev/os"
configFileGitRepoURL = fmt.Sprintf("https://%s/%s/%s", gs.repoHost, gs.repoPathParent, gs.repoName)
}
}

Expand Down Expand Up @@ -190,10 +195,10 @@ func buildCmd() *cobra.Command {
}

if len(args) > 0 {
options = append(options, build.WithConfig(args[0]))
options = append(options, build.WithConfig(buildConfigFilePath))

if sourceDir == "" {
sourceDir = filepath.Dir(args[0])
sourceDir = filepath.Dir(buildConfigFilePath)
}
}

Expand Down Expand Up @@ -279,27 +284,39 @@ type gitState struct {
repoName string
}

// Detect the git state of the current directory
func detectGitState(_ context.Context) (*gitState, error) {
// Detect the git state from the build config file's parent directory.
func detectGitState(ctx context.Context, buildConfigFilePath string) (*gitState, error) {
// Establish fallback values in case we error out early.
gs := &gitState{
commit: "unknown",
repoHost: "unknown",
repoPathParent: "unknown",
repoName: "unknown",
}

allowedRepoOwners := []string{
"wolfi-dev",
"chainguard-dev",
}

repo, err := git.PlainOpenWithOptions(".", &git.PlainOpenOptions{DetectDotGit: true})
repoDir := filepath.Dir(buildConfigFilePath)
clog.FromContext(ctx).Debugf("detecting git state from %q", repoDir)

repo, err := git.PlainOpenWithOptions(repoDir, &git.PlainOpenOptions{DetectDotGit: true})
if err != nil {
return nil, fmt.Errorf("opening git repository: %w", err)
return gs, fmt.Errorf("opening git repository: %w", err)
}

head, err := repo.Head()
if err != nil {
return nil, fmt.Errorf("determining HEAD: %w", err)
return gs, fmt.Errorf("determining HEAD: %w", err)
}
commit := head.Hash().String()
gs.commit = commit

remotes, err := repo.Remotes()
if err != nil {
return nil, fmt.Errorf("getting remotes: %w", err)
return gs, fmt.Errorf("getting remotes: %w", err)
}
for _, r := range remotes {
for _, u := range r.Config().URLs {
Expand All @@ -313,23 +330,23 @@ func detectGitState(_ context.Context) (*gitState, error) {
if host != "github.com" {
continue
}
gs.repoHost = host

if !slices.Contains(allowedRepoOwners, repoPathParent) {
continue
}
gs.repoPathParent = repoPathParent

if repoName == "" {
continue
}
gs.repoName = repoName

return &gitState{
repoHost: host,
repoPathParent: repoPathParent,
repoName: repoName,
commit: commit,
}, nil
return gs, nil
}
}

return nil, errors.New("no usable git remote found")
return gs, errors.New("no usable git remote found")
}

func parseGitTransportEndpoint(ep *transport.Endpoint) (host string, repoPathParent string, repoName string) {
Expand Down
Loading