Add code comments to gbm prepare command

cli/pkg/release/gbm.go

@@ -16,14 +16,20 @@ import (
 func CreateGbmPR(version, dir string) (gh.PullRequest, error) {
 	var pr gh.PullRequest
 
+	// Set Gutenberg Mobile directory
 	gbmDir := fmt.Sprintf("%s/gutenberg-mobile", dir)
 	git := g.NewClient(gbmDir, true)
 
+	// Set Gutenberg Mobile repository and org
 	org, err := repo.GetOrg("gutenberg-mobile")
 	console.ExitIfError(err)
 
+	// Set Gutenberg Mobile branch name e.g., (release/x.xx.x)
 	branch := "release/" + version
 
+	// Check if branch already exists
+	// Return if it does
+	// Otherwise, clone the repo and checkout the branch
 	console.Info("Checking if branch %s exists", branch)
 	exists, _ := gh.SearchBranch("gutenberg-mobile", branch)
 
@@ -45,6 +51,7 @@ func CreateGbmPR(version, dir string) (gh.PullRequest, error) {
 		}
 	}
 
+	// Update package versions for package.json and package-lock.json
 	console.Info("Updating package versions")
 	pkgs := []string{"./package.json", "./package-lock.json"}
 	for _, pkg := range pkgs {
@@ -53,28 +60,34 @@ func CreateGbmPR(version, dir string) (gh.PullRequest, error) {
 		}
 	}
 
+	// Commit package.json and package-lock.json
 	if err := git.CommitAll(gbmDir, "Release script: Update package.json version to %s", version); err != nil {
 		return pr, err
 	}
 
+	// Update the release-notes in the mobile package
 	if err := git.Submodule("update", "--init", "--recursive", "--depth=1", "--recommend-shallow"); err != nil {
 		return pr, err
 	}
 
+	// Set up Gutenberg Mobile node environment
 	console.Info("Setting up Gutenberg Mobile node environment")
 	if err := exec.SetupNode(gbmDir, true); err != nil {
 		return pr, err
 	}
 
+	// Create a git client for Gutenberg submodule so the Gutenberg ref can be updated to the correct branch
 	gbGit := g.NewClient(filepath.Join(gbmDir, "gutenberg"), true)
 	if err := gbGit.Switch("rnmobile/release_" + version); err != nil {
 		return pr, err
 	}
 
+	// Commit the updated Gutenberg submodule ref
 	if err := git.CommitAll(gbmDir, "Release script: Update gutenberg submodule"); err != nil {
 		return pr, err
 	}
 
+	// Run npm ci and npm run bundle
 	if err := exec.NpmCi(gbmDir, true); err != nil {
 		return pr, err
 	}
@@ -83,25 +96,31 @@ func CreateGbmPR(version, dir string) (gh.PullRequest, error) {
 		return pr, err
 	}
 
+	// Commit the updated bundle output
 	if err := git.CommitAll(gbmDir, "Release script: Update bundle for %s", version); err != nil {
 		return pr, err
 	}
 
+	// Update XCFramework builders project Podfile.lock
 	console.Info("Update XCFramework builders project Podfile.lock")
 	xcframeworkDir := fmt.Sprintf("%s/ios-xcframework", dir)
 
+	// Run `bundle install`
 	if err := exec.BundleInstall(xcframeworkDir, true); err != nil {
 		return pr, err
 	}
 
+	// Run `bundle exec pod install``
 	if err := exec.Bundle(xcframeworkDir, true, "exec", "pod", "install"); err != nil {
 		return pr, err
 	}
 
+	// Commit output of bundle commands
 	if err := git.CommitAll(xcframeworkDir, "Release script: Sync XCFramework `Podfile.lock` with %s", version); err != nil {
 		return pr, err
 	}
 
+	// Update the RELEASE-NOTES.txt and commit output
 	console.Info("Update the release-notes in the mobile package")
 	chnPath := filepath.Join(gbmDir, "RELEASE-NOTES.txt")
 	if err := utils.UpdateReleaseNotes(version, chnPath); err != nil {
@@ -114,6 +133,7 @@ func CreateGbmPR(version, dir string) (gh.PullRequest, error) {
 
 	console.Info("\n 🎉 Gutenberg Mobile preparations succeeded.")
 
+	// Create Gutenberg Mobile PR
 	console.Info("Creating PR for %s", branch)
 	pr.Title = fmt.Sprint("Release ", version)
 	pr.Base.Ref = "trunk"
@@ -123,13 +143,15 @@ func CreateGbmPR(version, dir string) (gh.PullRequest, error) {
 		console.Info("Unable to render the GB PR body (err %s)", err)
 	}
 
+	// Add PR labels
 	pr.Labels = []gh.Label{{
 		Name: "release-process",
 	}}
 
+	// Display PR preview
 	gh.PreviewPr("gutenberg-mobile", gbmDir, &pr)
 
-
+	// Add prompt to confirm PR creation
 	prompt := fmt.Sprintf("\nReady to create the PR on %s/gutenberg?", org)
 	cont := console.Confirm(prompt)
 
@@ -138,10 +160,12 @@ func CreateGbmPR(version, dir string) (gh.PullRequest, error) {
 		return pr, fmt.Errorf("exiting before creating PR")
 	}
 
+	// Push the branch
 	if err := git.Push(); err != nil {
 		return pr, err
 	}
 
+	// Create the PR
 	if err := gh.CreatePr("gutenberg-mobile", &pr); err != nil {
 		return pr, err
 	}