Skip to content

GitHub release assets download #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Snider wants to merge 1 commit into
base: main
Choose a base branch
from
Open

GitHub release assets download #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions cmd/collect_github_helpers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
package cmd

import (
"github.com/google/go-github/v39/github"
)

func findChecksumAsset(assets []*github.ReleaseAsset) *github.ReleaseAsset {
for _, asset := range assets {
// A common convention for checksum files.
// A more robust solution could be configured by the user.
if asset.GetName() == "checksums.txt" || asset.GetName() == "SHA256SUMS" {
return asset
}
}
return nil
}
206 changes: 93 additions & 113 deletions cmd/collect_github_release_subcommand.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,18 @@ import (
"os"
"path/filepath"

"github.com/Snider/Borg/pkg/datanode"
borg_github "github.com/Snider/Borg/pkg/github"
"bytes"
"github.com/google/go-github/v39/github"
"github.com/spf13/cobra"
"golang.org/x/mod/semver"
)

func NewCollectGithubReleaseCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "release [repository-url]",
Short: "Download the latest release of a file from GitHub releases",
Long: `Download the latest release of a file from GitHub releases. If the file or URL has a version number, it will check for a higher version and download it if found.`,
Args: cobra.ExactArgs(1),
Use: "release <owner/repo> [tag]",
Short: "Download a release from GitHub",
Long: `Download a specific release from GitHub. If no tag is specified, the latest release will be downloaded.`,
Args: cobra.RangeArgs(1, 2),
RunE: func(cmd *cobra.Command, args []string) error {
logVal := cmd.Context().Value("logger")
log, ok := logVal.(*slog.Logger)
Expand All @@ -28,124 +27,105 @@ func NewCollectGithubReleaseCmd() *cobra.Command {
}
repoURL := args[0]
outputDir, _ := cmd.Flags().GetString("output")
pack, _ := cmd.Flags().GetBool("pack")
file, _ := cmd.Flags().GetString("file")
version, _ := cmd.Flags().GetString("version")
assetsOnly, _ := cmd.Flags().GetBool("assets-only")
pattern, _ := cmd.Flags().GetString("pattern")
verifyChecksums, _ := cmd.Flags().GetBool("verify-checksums")

_, err := GetRelease(log, repoURL, outputDir, pack, file, version)
return err
},
}
cmd.PersistentFlags().String("output", ".", "Output directory for the downloaded file")
cmd.PersistentFlags().Bool("pack", false, "Pack all assets into a DataNode")
cmd.PersistentFlags().String("file", "", "The file to download from the release")
cmd.PersistentFlags().String("version", "", "The version to check against")
return cmd
}

func init() {
collectGithubCmd.AddCommand(NewCollectGithubReleaseCmd())
}

func GetRelease(log *slog.Logger, repoURL string, outputDir string, pack bool, file string, version string) (*github.RepositoryRelease, error) {
owner, repo, err := borg_github.ParseRepoFromURL(repoURL)
if err != nil {
return nil, fmt.Errorf("failed to parse repository url: %w", err)
}
owner, repo, err := borg_github.ParseRepoFromURL(repoURL)
if err != nil {
return fmt.Errorf("failed to parse repository url: %w", err)
}

release, err := borg_github.GetLatestRelease(owner, repo)
if err != nil {
return nil, fmt.Errorf("failed to get latest release: %w", err)
}
var release *github.RepositoryRelease
if len(args) == 2 {
tag := args[1]
log.Info("getting release by tag", "tag", tag)
release, err = borg_github.GetReleaseByTag(owner, repo, tag)
if err != nil {
return fmt.Errorf("failed to get release '%s': %w", tag, err)
}
} else {
log.Info("getting latest release")
release, err = borg_github.GetLatestRelease(owner, repo)
if err != nil {
return fmt.Errorf("failed to get latest release: %w", err)
}
}
if release == nil {
return errors.New("release not found")
}

log.Info("found latest release", "tag", release.GetTagName())
log.Info("found release", "tag", release.GetTagName())

if version != "" {
tag := release.GetTagName()
if !semver.IsValid(tag) {
log.Info("latest release tag is not a valid semantic version, skipping comparison", "tag", tag)
} else {
if !semver.IsValid(version) {
return nil, fmt.Errorf("invalid version string: %s", version)
}
if semver.Compare(tag, version) <= 0 {
log.Info("latest release is not newer than the provided version", "latest", tag, "provided", version)
return nil, nil
tag := release.GetTagName()
releaseDir := filepath.Join(outputDir, tag)
if err := os.MkdirAll(releaseDir, 0755); err != nil {
return fmt.Errorf("failed to create release directory: %w", err)
}
}
}

if pack {
dn := datanode.New()
var failedAssets []string
for _, asset := range release.Assets {
log.Info("downloading asset", "name", asset.GetName())
data, err := borg_github.DownloadReleaseAsset(asset)
if err != nil {
log.Error("failed to download asset", "name", asset.GetName(), "err", err)
failedAssets = append(failedAssets, asset.GetName())
continue
if !assetsOnly {
releaseNotes := release.GetBody()
if err := os.WriteFile(filepath.Join(releaseDir, "RELEASE.md"), []byte(releaseNotes), 0644); err != nil {
return fmt.Errorf("failed to write release notes: %w", err)
}
}
dn.AddData(asset.GetName(), data)
}
if len(failedAssets) > 0 {
return nil, fmt.Errorf("failed to download assets: %v", failedAssets)
}

tar, err := dn.ToTar()
if err != nil {
return nil, fmt.Errorf("failed to create datanode: %w", err)
}
for _, asset := range release.Assets {
if pattern != "" {
matched, err := filepath.Match(pattern, asset.GetName())
if err != nil {
return fmt.Errorf("invalid pattern: %w", err)
}
if !matched {
continue
}
}

if err := os.MkdirAll(outputDir, 0755); err != nil {
return nil, fmt.Errorf("failed to create output directory: %w", err)
}
basename := release.GetTagName()
if basename == "" {
basename = "release"
}
outputFile := filepath.Join(outputDir, basename+".dat")
log.Info("downloading asset", "name", asset.GetName())
assetPath := filepath.Join(releaseDir, asset.GetName())
file, err := os.Create(assetPath)
if err != nil {
return fmt.Errorf("failed to create asset file: %w", err)
}
defer file.Close()

err = os.WriteFile(outputFile, tar, 0644)
if err != nil {
return nil, fmt.Errorf("failed to write datanode: %w", err)
}
log.Info("datanode saved", "path", outputFile)
} else {
if len(release.Assets) == 0 {
log.Info("no assets found in the latest release")
return nil, nil
}
var assetToDownload *github.ReleaseAsset
if file != "" {
for _, asset := range release.Assets {
if asset.GetName() == file {
assetToDownload = asset
break
var checksumData []byte
if verifyChecksums {
checksumAsset := findChecksumAsset(release.Assets)
if checksumAsset == nil {
log.Warn("checksum file not found in release", "tag", tag)
} else {
buf := new(bytes.Buffer)
err := borg_github.DownloadReleaseAsset(checksumAsset, buf)
if err != nil {
log.Error("failed to download checksum file", "name", checksumAsset.GetName(), "err", err)
} else {
checksumData = buf.Bytes()
}
}
}
Comment on lines +93 to +106
Copy link

@gemini-code-assist gemini-code-assist bot Feb 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

This block of code for finding and downloading the checksum asset is inside the loop that iterates over all release assets. This is inefficient as it will re-download and process the checksum file for every single asset in the release.

This logic should be moved outside and before the for _, asset := range release.Assets loop to be executed only once per release.


if verifyChecksums && checksumData != nil {
err = borg_github.DownloadReleaseAssetWithChecksum(asset, checksumData, file)
} else {
err = borg_github.DownloadReleaseAsset(asset, file)
}
Comment on lines +85 to +112
Copy link

@gemini-code-assist gemini-code-assist bot Feb 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The indentation in this block is incorrect and inconsistent, which harms readability and maintainability. Please run gofmt on the file to automatically fix the formatting.


if err != nil {
log.Error("failed to download asset", "name", asset.GetName(), "err", err)
continue
}
}
if assetToDownload == nil {
return nil, fmt.Errorf("asset not found in the latest release: %s", file)
}
} else {
assetToDownload = release.Assets[0]
}
if outputDir != "" {
if err := os.MkdirAll(outputDir, 0755); err != nil {
return nil, fmt.Errorf("failed to create output directory: %w", err)
}
}
outputPath := filepath.Join(outputDir, assetToDownload.GetName())
log.Info("downloading asset", "name", assetToDownload.GetName())
data, err := borg_github.DownloadReleaseAsset(assetToDownload)
if err != nil {
return nil, fmt.Errorf("failed to download asset: %w", err)
}
err = os.WriteFile(outputPath, data, 0644)
if err != nil {
return nil, fmt.Errorf("failed to write asset to file: %w", err)
}
log.Info("asset downloaded", "path", outputPath)
return nil
},
}
return release, nil
cmd.Flags().String("output", "releases", "Output directory for the releases")
cmd.Flags().Bool("assets-only", false, "Only download assets, skip release notes")
cmd.Flags().String("pattern", "", "Filter assets by filename pattern")
cmd.Flags().Bool("verify-checksums", false, "Verify checksums after download")
return cmd
}

func init() {
collectGithubCmd.AddCommand(NewCollectGithubReleaseCmd())
}
Loading
Loading