wip: checkpoint

Author: jmgilman

cli/pkg/release/providers/docs.go

@@ -5,6 +5,7 @@ import (
 	"log/slog"
 	"os"
 	"path/filepath"
+	"time"
 
 	"github.com/input-output-hk/catalyst-forge/cli/pkg/earthly"
 	"github.com/input-output-hk/catalyst-forge/cli/pkg/events"
@@ -82,7 +83,22 @@ func (r *DocsReleaser) Release() error {
 	}
 
 	r.logger.Info("Checking out branch", "branch", r.config.Branch)
-	if err := git.CheckoutBranch(r.project.Repo, r.config.Branch, git.GitCheckoutRemote()); err != nil {
+	if err := git.CheckoutBranch(
+		r.project.Repo,
+		r.config.Branch,
+		git.GitCheckoutRemote(),
+	); err != nil {
+		return fmt.Errorf("failed to checkout branch: %w", err)
+	}
+
+	tempBranch := generateTempBranch()
+	r.logger.Info("Creating orphan branch", "branch", tempBranch)
+	if err := git.CheckoutBranch(
+		r.project.Repo,
+		tempBranch,
+		git.GitCheckoutOrphan(),
+		git.GitCheckoutCreate(),
+	); err != nil {
 		return fmt.Errorf("failed to checkout branch: %w", err)
 	}
 
@@ -191,6 +207,12 @@ func (r *DocsReleaser) clean(targetPath string) error {
 	return nil
 }
 
+// generateBranchName generates a temporary branch name.
+func generateTempBranch() string {
+	timestamp := time.Now().Format("20060102-150405")
+	return fmt.Sprintf("%s-%s", "forge-gh-pages", timestamp)
+}
+
 // run runs the release target.
 func (r *DocsReleaser) run(path string) error {
 	return r.runner.RunTarget(

lib/tools/git/util.go

@@ -21,6 +21,7 @@ var (
 type gitCheckoutOptions struct {
 	create     bool
 	forceClean bool
+	orphan     bool
 	remote     bool
 }
 
@@ -43,6 +44,14 @@ func GitCheckoutForceClean() GitCheckoutOption {
 	}
 }
 
+// GitCheckoutOrphan sets the orphan option for the Git checkout.
+func GitCheckoutOrphan() GitCheckoutOption {
+	return func(o *gitCheckoutOptions) {
+		o.orphan = true
+	}
+}
+
+// GitCheckoutRemote sets the remote option for the Git checkout.
 func GitCheckoutRemote() GitCheckoutOption {
 	return func(o *gitCheckoutOptions) {
 		o.remote = true
@@ -115,15 +124,20 @@ func CheckoutBranch(r *git.Repository, branch string, opts ...GitCheckoutOption)
 		create = false
 	}
 
-	var branchRef string
+	var branchRef plumbing.ReferenceName
 	if options.remote {
-		branchRef = fmt.Sprintf("refs/remotes/origin/%s", branch)
+		branchRef = plumbing.ReferenceName(fmt.Sprintf("refs/remotes/origin/%s", branch))
+	} else if options.orphan {
+		branchRef = plumbing.NewHashReference(
+			plumbing.NewBranchReferenceName(branch),
+			plumbing.ZeroHash,
+		).Name()
 	} else {
-		branchRef = fmt.Sprintf("refs/heads/%s", branch)
+		branchRef = plumbing.NewBranchReferenceName(branch)
 	}
 
 	if err := wt.Checkout(&git.CheckoutOptions{
-		Branch: plumbing.ReferenceName(branchRef),
+		Branch: branchRef,
 		Create: create,
 	}); err != nil {
 		return fmt.Errorf("failed to checkout branch: %w", err)