feat: add pre-release flag to GitHub releases

This change adds the ability to mark GitHub releases as pre-releases by:
- Adding a new 'pre-release' flag to the upload command
- Updating the configuration to support the pre-release option
- Implementing the pre-release flag in the GitHub release creation
- Adding tests for the pre-release functionality
- Updating documentation in README.md

Signed-off-by: Yishay Nadav <ynadav@paloaltonetworks.com>

Author: yishaynaPalo

README.md

@@ -106,6 +106,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")
+      --pre-release                    Mark the release as a pre-release
       --packages-with-index            Host the package files in the GitHub Pages branch
 
 Global Flags:

cr/cmd/upload.go

@@ -62,4 +62,5 @@ func init() {
 	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")
+	uploadCmd.Flags().Bool("pre-release", false, "Mark the release as a pre-release")
 }

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"`
+	PreRelease           bool   `mapstructure:"pre-release"`
 	PackagesWithIndex    bool   `mapstructure:"packages-with-index"`
 }
 

pkg/github/github.go

@@ -36,6 +36,7 @@ type Release struct {
 	Commit               string
 	GenerateReleaseNotes bool
 	MakeLatest           string
+	PreRelease           bool
 }
 
 type Asset struct {
@@ -111,6 +112,7 @@ func (c *Client) CreateRelease(_ context.Context, input *Release) error {
 		TargetCommitish:      &input.Commit,
 		GenerateReleaseNotes: &input.GenerateReleaseNotes,
 		MakeLatest:           &input.MakeLatest,
+		Prerelease:           &input.PreRelease,
 	}
 
 	release, _, err := c.Repositories.CreateRelease(context.TODO(), c.owner, c.repo, req)

pkg/releaser/releaser.go

@@ -328,6 +328,7 @@ func (r *Releaser) CreateReleases() error {
 			Commit:               r.config.Commit,
 			GenerateReleaseNotes: r.config.GenerateReleaseNotes,
 			MakeLatest:           strconv.FormatBool(r.config.MakeReleaseLatest),
+			PreRelease:           r.config.PreRelease,
 		}
 		provFile := fmt.Sprintf("%s.prov", p)
 		if _, err := os.Stat(provFile); err == nil {

pkg/releaser/releaser_test.go

@@ -362,6 +362,7 @@ func TestReleaser_CreateReleases(t *testing.T) {
 		version     string
 		commit      string
 		latest      string
+		preRelease  bool
 		Releaser    *Releaser
 		error       bool
 	}{
@@ -372,6 +373,7 @@ func TestReleaser_CreateReleases(t *testing.T) {
 			version:     "0.1.0",
 			commit:      "",
 			latest:      "true",
+			preRelease:  false,
 			Releaser: &Releaser{
 				config: &config.Options{
 					PackagePath:       "testdata/does-not-exist",
@@ -389,6 +391,7 @@ func TestReleaser_CreateReleases(t *testing.T) {
 			version:     "0.1.0",
 			commit:      "",
 			latest:      "true",
+			preRelease:  false,
 			Releaser: &Releaser{
 				config: &config.Options{
 					PackagePath:       "testdata/release-packages",
@@ -406,6 +409,7 @@ func TestReleaser_CreateReleases(t *testing.T) {
 			version:     "0.1.0",
 			commit:      "5e239bd19fbefb9eb0181ecf0c7ef73b8fe2753c",
 			latest:      "true",
+			preRelease:  false,
 			Releaser: &Releaser{
 				config: &config.Options{
 					PackagePath:       "testdata/release-packages",
@@ -423,6 +427,7 @@ func TestReleaser_CreateReleases(t *testing.T) {
 			version:     "0.1.0",
 			commit:      "5e239bd19fbefb9eb0181ecf0c7ef73b8fe2753c",
 			latest:      "true",
+			preRelease:  false,
 			Releaser: &Releaser{
 				config: &config.Options{
 					PackagePath:       "testdata/release-packages",
@@ -434,6 +439,25 @@ func TestReleaser_CreateReleases(t *testing.T) {
 			},
 			error: false,
 		},
+		{
+			name:        "valid-package-with-pre-release",
+			packagePath: "testdata/release-packages",
+			chart:       "test-chart",
+			version:     "0.1.0",
+			commit:      "5e239bd19fbefb9eb0181ecf0c7ef73b8fe2753c",
+			latest:      "true",
+			preRelease:  true,
+			Releaser: &Releaser{
+				config: &config.Options{
+					PackagePath:       "testdata/release-packages",
+					Commit:            "5e239bd19fbefb9eb0181ecf0c7ef73b8fe2753c",
+					PackagesWithIndex: false,
+					MakeReleaseLatest: true,
+					PreRelease:        true,
+				},
+			},
+			error: false,
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
@@ -466,6 +490,7 @@ func TestReleaser_CreateReleases(t *testing.T) {
 				assert.Equal(t, assetPath, fakeGitHub.release.Assets[0].Path)
 				assert.Equal(t, tt.commit, fakeGitHub.release.Commit)
 				assert.Equal(t, tt.latest, fakeGitHub.release.MakeLatest)
+				assert.Equal(t, tt.preRelease, fakeGitHub.release.PreRelease)
 				assert.Equal(t, tt.Releaser.config.Commit, fakeGitHub.release.Commit)
 				if !tt.Releaser.config.PackagesWithIndex {
 					fakeGit.AssertNumberOfCalls(t, "AddWorktree", 0)