Add option to host the chart package files in the GitHub Pages branch (#123)

* add packages-with-index flag

Signed-off-by: Steven Barnes <[email protected]>

* Add unit tests

Signed-off-by: Steven Barnes <[email protected]>

* delete files created by test

Signed-off-by: Steven Barnes <[email protected]>

* Authenticate to get existing index.yaml

Signed-off-by: Steven Barnes <[email protected]>

* update docs

Signed-off-by: cpanato <[email protected]>

* fix lints

Signed-off-by: cpanato <[email protected]>

* add git pull function

Signed-off-by: cpanato <[email protected]>

* update help text for upload command

Signed-off-by: cpanato <[email protected]>

---------

Signed-off-by: Steven Barnes <[email protected]>
Signed-off-by: cpanato <[email protected]>
Co-authored-by: cpanato <[email protected]>

Author: annabarnes1138

README.md

@@ -86,6 +86,7 @@ Flags:
       --skip-existing                  Skip upload if release exists
   -t, --token string                   GitHub Auth Token
       --make-release-latest bool       Mark the created GitHub release as 'latest' (default "true")
+      --packages-with-index            Host the package files in the GitHub Pages branch
 
 Global Flags:
       --config string   Config file (default is $HOME/.cr.yaml)
@@ -118,6 +119,7 @@ Flags:
       --release-name-template string   Go template for computing release names, using chart metadata (default "{{ .Name }}-{{ .Version }}")
       --remote string                  The Git remote used when creating a local worktree for the GitHub Pages branch (default "origin")
   -t, --token string                   GitHub Auth Token (only needed for private repos)
+      --packages-with-index            Host the package files in the GitHub Pages branch
 
 Global Flags:
       --config string   Config file (default is $HOME/.cr.yaml)

cr/cmd/index.go

@@ -76,4 +76,5 @@ func init() {
 	flags.Bool("push", false, "Push index.yaml to the GitHub Pages branch (must not be set if --pr is set)")
 	flags.Bool("pr", false, "Create a pull request for index.yaml against the GitHub Pages branch (must not be set if --push is set)")
 	flags.String("release-name-template", "{{ .Name }}-{{ .Version }}", "Go template for computing release names, using chart metadata")
+	flags.Bool("packages-with-index", false, "Host the package files in the GitHub Pages branch")
 }

cr/cmd/upload.go

@@ -57,4 +57,9 @@ func init() {
 		"If it is set to empty string, or the file is not found, the chart description will be used instead. The file is read from the chart package")
 	uploadCmd.Flags().Bool("generate-release-notes", false, "Whether to automatically generate the name and body for this release. See https://docs.github.com/en/rest/releases/releases")
 	uploadCmd.Flags().Bool("make-release-latest", true, "Mark the created GitHub release as 'latest'")
+	uploadCmd.Flags().String("pages-branch", "gh-pages", "The GitHub pages branch")
+	uploadCmd.Flags().String("remote", "origin", "The Git remote used when creating a local worktree for the GitHub Pages branch")
+	uploadCmd.Flags().Bool("push", false, "Push the chart package to the GitHub Pages branch (must not be set if --pr is set)")
+	uploadCmd.Flags().Bool("pr", false, "Create a pull request for the chart package against the GitHub Pages branch (must not be set if --push is set)")
+	uploadCmd.Flags().Bool("packages-with-index", false, "Host the package files in the GitHub Pages branch")
 }

doc/cr_index.md

@@ -23,6 +23,7 @@ cr index [flags]
   -i, --index-path string              Path to index file (default ".cr-index/index.yaml")
   -o, --owner string                   GitHub username or organization
   -p, --package-path string            Path to directory with chart packages (default ".cr-release-packages")
+      --packages-with-index            Host the package files in the GitHub Pages branch
       --pages-branch string            The GitHub pages branch (default "gh-pages")
       --pages-index-path string        The GitHub pages index path (default "index.yaml")
       --pr                             Create a pull request for index.yaml against the GitHub Pages branch (must not be set if --push is set)

doc/cr_upload.md

@@ -22,8 +22,13 @@ cr upload [flags]
       --make-release-latest            Mark the created GitHub release as 'latest' (default true)
   -o, --owner string                   GitHub username or organization
   -p, --package-path string            Path to directory with chart packages (default ".cr-release-packages")
+      --packages-with-index            Host the package files in the GitHub Pages branch
+      --pages-branch string            The GitHub pages branch (default "gh-pages")
+      --pr                             Create a pull request for the chart package against the GitHub Pages branch (must not be set if --push is set)
+      --push                           Push the chart package to the GitHub Pages branch (must not be set if --pr is set)
       --release-name-template string   Go template for computing release names, using chart metadata (default "{{ .Name }}-{{ .Version }}")
       --release-notes-file string      Markdown file with chart release notes. If it is set to empty string, or the file is not found, the chart description will be used instead. The file is read from the chart package
+      --remote string                  The Git remote used when creating a local worktree for the GitHub Pages branch (default "origin")
       --skip-existing                  Skip upload if release exists
   -t, --token string                   GitHub Auth Token
 ```

pkg/config/config.go

@@ -61,6 +61,7 @@ type Options struct {
 	ReleaseNotesFile     string `mapstructure:"release-notes-file"`
 	GenerateReleaseNotes bool   `mapstructure:"generate-release-notes"`
 	MakeReleaseLatest    bool   `mapstructure:"make-release-latest"`
+	PackagesWithIndex    bool   `mapstructure:"packages-with-index"`
 }
 
 func LoadConfiguration(cfgFile string, cmd *cobra.Command, requiredFlags []string) (*Options, error) {

pkg/git/git.go

@@ -60,6 +60,14 @@ func (g *Git) Commit(workingDir string, message string) error {
 	return runCommand(workingDir, command)
 }
 
+// UpdateBranch runs 'git pull' with the given args.
+func (g *Git) Pull(workingDir string, args ...string) error {
+	pullArgs := []string{"pull"}
+	pullArgs = append(pullArgs, args...)
+	command := exec.Command("git", pullArgs...)
+	return runCommand(workingDir, command)
+}
+
 // Push runs 'git push' with the given args.
 func (g *Git) Push(workingDir string, args ...string) error {
 	pushArgs := []string{"push"}

pkg/releaser/releaser.go

@@ -55,6 +55,7 @@ type GitHub interface {
 
 type HTTPClient interface {
 	Get(url string) (*http.Response, error)
+	GetWithToken(url string, token string) (*http.Response, error)
 }
 
 type Git interface {
@@ -63,6 +64,7 @@ type Git interface {
 	Add(workingDir string, args ...string) error
 	Commit(workingDir string, message string) error
 	Push(workingDir string, args ...string) error
+	Pull(workingDir string, args ...string) error
 	GetPushURL(remote string, token string) (string, error)
 }
 
@@ -213,36 +215,21 @@ func (r *Releaser) UpdateIndexFile() (bool, error) {
 	if err := copyFile(r.config.IndexPath, indexYamlPath); err != nil {
 		return false, err
 	}
-	if err := r.git.Add(worktree, indexYamlPath); err != nil {
+
+	if err := r.git.Pull(worktree, r.config.Remote, r.config.PagesBranch); err != nil {
 		return false, err
 	}
-	if err := r.git.Commit(worktree, fmt.Sprintf("Update %s", r.config.PagesIndexPath)); err != nil {
+
+	if err := r.git.Add(worktree, indexYamlPath); err != nil {
 		return false, err
 	}
 
-	pushURL, err := r.git.GetPushURL(r.config.Remote, r.config.Token)
-	if err != nil {
+	if err := r.git.Commit(worktree, fmt.Sprintf("Update %s", r.config.PagesIndexPath)); err != nil {
 		return false, err
 	}
 
-	if r.config.Push {
-		fmt.Printf("Pushing to branch %q\n", r.config.PagesBranch)
-		if err := r.git.Push(worktree, pushURL, "HEAD:refs/heads/"+r.config.PagesBranch); err != nil {
-			return false, err
-		}
-	} else if r.config.PR {
-		branch := fmt.Sprintf("chart-releaser-%s", randomString(16))
-
-		fmt.Printf("Pushing to branch %q\n", branch)
-		if err := r.git.Push(worktree, pushURL, "HEAD:refs/heads/"+branch); err != nil {
-			return false, err
-		}
-		fmt.Printf("Creating pull request against branch %q\n", r.config.PagesBranch)
-		prURL, err := r.github.CreatePullRequest(r.config.Owner, r.config.GitRepo, "Update index.yaml", branch, r.config.PagesBranch)
-		if err != nil {
-			return false, err
-		}
-		fmt.Println("Pull request created:", prURL)
+	if err := r.pushToPagesBranch(worktree); err != nil {
+		return false, err
 	}
 
 	return true, nil
@@ -302,6 +289,12 @@ func (r *Releaser) addToIndexFile(indexFile *repo.IndexFile, url string) error {
 	s := strings.Split(url, "/")
 	s = s[:len(s)-1]
 
+	if r.config.PackagesWithIndex {
+		// the chart will be stored in the same repo as
+		// the index file so let's make the path relative
+		s = s[:0]
+	}
+
 	// Add to index
 	if err := indexFile.MustAdd(c.Metadata, filepath.Base(arch), strings.Join(s, "/"), hash); err != nil {
 		return err
@@ -354,6 +347,31 @@ func (r *Releaser) CreateReleases() error {
 		if err := r.github.CreateRelease(context.TODO(), release); err != nil {
 			return errors.Wrapf(err, "error creating GitHub release %s", releaseName)
 		}
+
+		if r.config.PackagesWithIndex {
+			worktree, err := r.git.AddWorktree("", r.config.Remote+"/"+r.config.PagesBranch)
+			if err != nil {
+				return err
+			}
+			defer r.git.RemoveWorktree("", worktree) //nolint: errcheck
+
+			pkgTargetPath := filepath.Join(worktree, filepath.Base(p))
+			if err := copyFile(p, pkgTargetPath); err != nil {
+				return err
+			}
+
+			if err := r.git.Add(worktree, pkgTargetPath); err != nil {
+				return err
+			}
+
+			if err := r.git.Commit(worktree, fmt.Sprintf("Publishing chart package for %s", releaseName)); err != nil {
+				return err
+			}
+
+			if err := r.pushToPagesBranch(worktree); err != nil {
+				return err
+			}
+		}
 	}
 
 	return nil
@@ -363,6 +381,35 @@ func (r *Releaser) getListOfPackages(dir string) ([]string, error) {
 	return filepath.Glob(filepath.Join(dir, "*.tgz"))
 }
 
+func (r *Releaser) pushToPagesBranch(worktree string) error {
+	pushURL, err := r.git.GetPushURL(r.config.Remote, r.config.Token)
+	if err != nil {
+		return err
+	}
+
+	if r.config.Push {
+		fmt.Printf("Pushing to branch %q\n", r.config.PagesBranch)
+		if err := r.git.Push(worktree, pushURL, "HEAD:refs/heads/"+r.config.PagesBranch); err != nil {
+			return err
+		}
+	} else if r.config.PR {
+		branch := fmt.Sprintf("chart-releaser-%s", randomString(16))
+
+		fmt.Printf("Pushing to branch %q\n", branch)
+		if err := r.git.Push(worktree, pushURL, "HEAD:refs/heads/"+branch); err != nil {
+			return err
+		}
+		fmt.Printf("Creating pull request against branch %q\n", r.config.PagesBranch)
+		prURL, err := r.github.CreatePullRequest(r.config.Owner, r.config.GitRepo, "Update index.yaml", branch, r.config.PagesBranch)
+		if err != nil {
+			return err
+		}
+		fmt.Println("Pull request created:", prURL)
+	}
+
+	return nil
+}
+
 func copyFile(srcFile string, dstFile string) error {
 	source, err := os.Open(srcFile)
 	if err != nil {