feat: support for automatically updating to prereleases (#147)

* feat: support for automatically updating to prereleases

* fix: skip non pre-releases in pre-release filter

Author: steveiliop56

Makefile

@@ -1,13 +1,18 @@
 # Makefile for runtipi CLI
 
+# Build values
+VERSION := nightly
+COMMIT := $(shell git rev-parse HEAD)
+DATE := $(shell date +%Y-%m-%dT%H:%M:%S%z)
+
 # Define the root folder path
 ROOT_FOLDER_HOST := ~/temp/runtipi
 
 # Main target that creates the directory and runs the program
 .PHONY: run
 run:
 	@mkdir -p $(ROOT_FOLDER_HOST)
-	@ROOT_FOLDER_HOST=$(ROOT_FOLDER_HOST) go run -ldflags="-X main.version=nightly -X main.commit=$(git rev-parse HEAD) -X main.buildDate=$(date +%Y-%m-%dT%H:%M:%S%z)" cmd/runtipi/main.go $(ARGS)
+	@ROOT_FOLDER_HOST=$(ROOT_FOLDER_HOST) go run -ldflags="-X main.version=$(VERSION) -X main.commit=$(COMMIT) -X main.buildDate=$(DATE)" cmd/runtipi/main.go $(ARGS)
 
 # Build the program
 .PHONY: build

cmd/runtipi/main.go

@@ -13,9 +13,9 @@ import (
 )
 
 var (
-	version   string
-	commit    string
-	buildDate string
+	version   = "dev"
+	commit    = "unknown"
+	buildDate = "unknown"
 )
 
 func init() {
@@ -45,16 +45,6 @@ func init() {
 		config.RootFolder = envRootFolder
 	}
 
-	if version == "" {
-		version = "dev"
-	}
-	if commit == "" {
-		commit = "unknown"
-	}
-	if buildDate == "" {
-		buildDate = "unknown"
-	}
-
 	config.Info = config.AppInfo{
 		Version:   version,
 		Commit:    commit,

internal/commands/debug.go

@@ -83,9 +83,9 @@ func RunDebug() {
 		envExists = color.YellowString("Yes")
 	}
 
-	fmt.Printf("\n--- %s ---\n", color.BlueString("Tipi configuration"))
+	fmt.Printf("\n--- %s ---\n", color.BlueString("Runtipi configuration"))
 	configTable := tablewriter.NewWriter(os.Stdout)
-	configTable.Append([]string{"Custom tipi docker config", configExists})
+	configTable.Append([]string{"Custom runtipi docker config", configExists})
 	configTable.Append([]string{"Custom environment file", envExists})
 	configTable.Render()
 

internal/commands/update.go

@@ -13,23 +13,51 @@ import (
 	"github.com/runtipi/cli/internal/utils"
 )
 
+const PreReleaseWarning = "You are updating to pre-release version which may contain bugs, we are not responsible for any issues that may arise"
+
 func RunUpdate(args types.UpdateArgs) {
 	spin := components.NewSpinner("")
 	spin.SetMessage("Grabbing releases from GitHub")
 
 	var wantedVersion string
-	if args.Version.IsLatest() {
-		latest, err := utils.GetLatestRelease()
+
+	switch args.Version.String() {
+	case "latest":
+		latest, err := utils.GetReleases("https://api.github.com/repos/runtipi/runtipi/releases/latest")
 		if err != nil {
 			spin.Fail("Failed to fetch latest release")
 			spin.Finish()
 			fmt.Printf("\nError: %v\n", err)
 			return
 		}
-		wantedVersion = latest
-	} else if args.Version.IsNightly() {
+		if len(latest) == 0 {
+			spin.Fail("Failed to fetch latest release")
+			spin.Finish()
+			fmt.Printf("\nError: No releases found\n")
+			return
+		}
+		wantedVersion = latest[0].TagName
+	case "nightly":
+		spin.Warn(PreReleaseWarning)
 		wantedVersion = "nightly"
-	} else {
+	case "prerelease":
+		spin.Warn(PreReleaseWarning)
+		releases, err := utils.GetReleases("https://api.github.com/repos/runtipi/runtipi/releases")
+		if err != nil {
+			spin.Fail("Failed to fetch latest prerelease")
+			spin.Finish()
+			fmt.Printf("\nError: %v\n", err)
+			return
+		}
+		filtered := utils.FilterNonPreReleases(releases)
+		if len(filtered) == 0 {
+			spin.Fail("Failed to fetch latest prerelease")
+			spin.Finish()
+			fmt.Printf("\nError: No prerelease releases found\n")
+			return
+		}
+		wantedVersion = filtered[0].TagName
+	default:
 		wantedVersion = args.Version.String()
 	}
 
@@ -47,7 +75,7 @@ func RunUpdate(args types.UpdateArgs) {
 		return
 	}
 
-	spin.Succeed("Tipi updated successfully. Starting new CLI")
+	spin.Succeed("Runtipi updated successfully. Starting new CLI")
 	spin.Finish()
 
 	newExecutablePath := filepath.Join(config.RootFolder, "runtipi-cli")

internal/types/version.go

@@ -9,27 +9,29 @@ import (
 
 type VersionType struct {
 	version *semver.Version
-	kind    string // "latest", "nightly", or "version"
+	kind    string // "latest", "nightly", "prerelease", or "version"
 }
 
 func NewVersion(s string) (*VersionType, error) {
 	s = strings.TrimSpace(s)
-	if s == "latest" {
+
+	switch s {
+	case "latest":
 		return &VersionType{kind: "latest"}, nil
-	}
-	if s == "nightly" {
+	case "nightly":
 		return &VersionType{kind: "nightly"}, nil
+	case "prerelease":
+		return &VersionType{kind: "prerelease"}, nil
+	default:
+		version, err := semver.NewVersion(s)
+		if err != nil {
+			return nil, fmt.Errorf("invalid version format: %w", err)
+		}
+		return &VersionType{
+			version: version,
+			kind:    "version",
+		}, nil
 	}
-
-	version, err := semver.NewVersion(s)
-	if err != nil {
-		return nil, fmt.Errorf("invalid version format: %w", err)
-	}
-
-	return &VersionType{
-		version: version,
-		kind:    "version",
-	}, nil
 }
 
 // The string representation of the version
@@ -39,6 +41,8 @@ func (v *VersionType) String() string {
 		return "latest"
 	case "nightly":
 		return "nightly"
+	case "prerelease":
+		return "prerelease"
 	default:
 		return fmt.Sprintf("v%s", v.version.String())
 	}
@@ -52,6 +56,10 @@ func (v *VersionType) IsNightly() bool {
 	return v.kind == "nightly"
 }
 
+func (v *VersionType) IsPrerelease() bool {
+	return v.kind == "prerelease"
+}
+
 func (v *VersionType) Version() *semver.Version {
 	return v.version
 }

internal/utils/release.go

@@ -8,13 +8,16 @@ import (
 	"os"
 	"path/filepath"
 	"runtime"
+	"slices"
 	"strings"
 	"time"
 
 	"github.com/Masterminds/semver/v3"
 	"github.com/runtipi/cli/internal/config"
 )
 
+var NonPreReleaseTags = []string{"nightly", "e2e"}
+
 type GitHubRelease struct {
 	TagName     string `json:"tag_name"`
 	Name        string `json:"name"`
@@ -28,32 +31,40 @@ type GitHubRelease struct {
 	} `json:"assets"`
 }
 
-func GetLatestRelease() (string, error) {
-	url := "https://api.github.com/repos/runtipi/runtipi/releases/latest"
-
+func GetReleases(url string) ([]GitHubRelease, error) {
 	req, err := http.NewRequest("GET", url, nil)
 	if err != nil {
-		return "", fmt.Errorf("failed to create request: %v", err)
+		return nil, fmt.Errorf("failed to create request: %v", err)
 	}
 
 	req.Header.Set("User-Agent", "Runtipi-CLI")
 	client := &http.Client{Timeout: 10 * time.Second}
 	resp, err := client.Do(req)
 	if err != nil {
-		return "", fmt.Errorf("failed to send request: %v", err)
+		return nil, fmt.Errorf("failed to send request: %v", err)
 	}
 	defer resp.Body.Close()
 
 	if resp.StatusCode != http.StatusOK {
-		return "", fmt.Errorf("failed to fetch latest release. Status code: %d", resp.StatusCode)
+		return nil, fmt.Errorf("failed to fetch releases. Status code: %d", resp.StatusCode)
 	}
 
-	var release GitHubRelease
-	if err := json.NewDecoder(resp.Body).Decode(&release); err != nil {
-		return "", fmt.Errorf("failed to parse latest release: %v", err)
+	body, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return nil, fmt.Errorf("failed to read response body: %v", err)
 	}
 
-	return release.TagName, nil
+	// The latest release is not returned in an array so we will try to decode it as a single release
+	var releases []GitHubRelease
+	if err := json.Unmarshal(body, &releases); err != nil {
+		var release GitHubRelease
+		if err := json.Unmarshal(body, &release); err != nil {
+			return nil, fmt.Errorf("failed to parse releases: %v", err)
+		}
+		releases = append(releases, release)
+	}
+
+	return releases, nil
 }
 
 func IsMajorBump(currentVersion, newVersion string) bool {
@@ -190,3 +201,14 @@ func FindReleaseByVersion(version string) (GitHubRelease, error) {
 
 	return GitHubRelease{}, fmt.Errorf("release not found. Did you forget the v prefix? (e.g. v4.0.0 instead of 4.0.0)")
 }
+
+func FilterNonPreReleases(releases []GitHubRelease) []GitHubRelease {
+	var filtered []GitHubRelease
+	for _, release := range releases {
+		if slices.Contains(NonPreReleaseTags, release.TagName) || !release.Prerelease {
+			continue
+		}
+		filtered = append(filtered, release)
+	}
+	return filtered
+}