fix: ensure directory exists before rolling backup

fix: don't create backup directory for dry-run
docs: only authenticated user will fetch shared repos

Author: slashtechno

config.example.yaml

@@ -12,7 +12,7 @@ log-level: info
 output: backup
 # GitHub token with read access to the repositories and user
 token: ""
-# List of usernames to fetch. If neither usernames or in-org is set, it will fetch the token owner's repositories
+# List of usernames to fetch. If neither usernames or in-org are set (or an empty string is passed), the authenticated user will (also) be fetched. Fetching the authenticated user also fetches repositories shared with the authenticated user.
 usernames: []
 # `clone` (clone the repositories), `fetch` (fetch the repositories and write to output if it ends in .json or `repositories.json` in output), `dry-run` (fetch the repositories and print the output)
 run-type: clone

pkg/backup/backup.go

@@ -100,6 +100,8 @@ func Backup(config BackupConfig) error {
 		repos = append(repos, fetchedRepos.Starred...)
 	}
 	if len(allUsers) == 0 {
+		// Just to be verbose, set the username to ""
+		fetchConfig.Username = ""
 		fetchedRepos, err := GetRepositories(
 			fetchConfig,
 		)
@@ -227,7 +229,7 @@ func StartBackup(
 		var wg sync.WaitGroup
 
 		// Run backup on start
-		backupConfig.Output, err = utils.RollingDir(parentDir, maxBackups)
+		backupConfig.Output, err = rollingDirIfNotDryRun(backupConfig, maxBackups, parentDir)
 		if err != nil {
 			return err
 		}
@@ -241,8 +243,7 @@ func StartBackup(
 			// The backup will not be concurrent if the backup process takes longer than the interval
 			for range ticker.C {
 				wg.Add(1)
-
-				backupConfig.Output, err = utils.RollingDir(parentDir, maxBackups)
+				backupConfig.Output, err = rollingDirIfNotDryRun(backupConfig, maxBackups, parentDir)
 				if err != nil {
 					errChan <- err
 					return
@@ -272,3 +273,13 @@ func StartBackup(
 	}
 	return nil
 }
+
+// Only run utils.RollingDir if not in a dry run
+func rollingDirIfNotDryRun(config BackupConfig, maxBackups int, parentDir string) (string, error) {
+	if config.RunType != "dry-run" {
+		return utils.RollingDir(filepath.Clean(parentDir), maxBackups)
+	} else {
+		log.Debug("Dry run - not rolling directories")
+	}
+	return config.Output, nil
+}

pkg/backup/repositories.go

@@ -62,7 +62,6 @@ func GetRepositories(config *FetchConfig) (*Repositories, error) {
 		return nil, err
 	}
 	username := user.GetLogin()
-	log.Info("Fetching repositories for user", "username", username)
 
 	// https://github.com/google/go-github?tab=readme-ov-file#pagination
 	listOptions := github.ListOptions{PerPage: 100}
@@ -71,6 +70,8 @@ func GetRepositories(config *FetchConfig) (*Repositories, error) {
 	// https://pkg.go.dev/github.com/google/go-github/v63@v63.0.0/github#RepositoriesService.ListByUser
 	var userRepos []*github.Repository
 	if config.Username == "" {
+		log.Info("Fetching repositories for the authenticated user; shared repositories will also be fetched.", "username", username)
+
 		opt := &github.RepositoryListByAuthenticatedUserOptions{
 			ListOptions: listOptions,
 		}
@@ -86,6 +87,9 @@ func GetRepositories(config *FetchConfig) (*Repositories, error) {
 			opt.Page = resp.NextPage
 		}
 	} else {
+
+		log.Info("Fetching repositories for user", "username", username)
+
 		opt := &github.RepositoryListByUserOptions{
 			ListOptions: listOptions,
 		}

pkg/utils/utils.go

@@ -52,6 +52,12 @@ func RollingDir(pathToDir string, maxBackups int) (string, error) {
 	// Get all directories in the path
 	dirs := []string{}
 
+	// Whilst the directory is created when backing up (clone or fetch), that's later. If the directory doesn't exist, os.ReadDir error. Thus, ensure it, and any parent directories, exist.
+	err := os.MkdirAll(pathToDir, 0644)
+	if err != nil {
+		return "", err
+	}
+
 	filesAndDirs, err := os.ReadDir(pathToDir)
 	if err != nil {
 		return "", err