feat: Add configuration to exclude repositories from being fetched. (#22)

Author: kleinmann

.github/workflows/build.yml

@@ -41,7 +41,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-go@v2
         with:
-          go-version: '^1.17.8'
+          go-version: '^1.18.10'
       - run: ${{ matrix.goopts }} go build -o ${{ matrix.filename }} -ldflags="-X 'main.Version=${GITHUB_REF##*/}' -X 'main.CommitHash=${GITHUB_SHA}' -X 'main.BuildTimestamp=$(date)'" ./cmd/git-backup
         env:
           GOOS: ${{ matrix.goos }}

README.md

@@ -39,6 +39,9 @@ github:
     # your self-hosted github install.
     # (default: https://api.github.com)
     url: https://github.mydomain.com
+    # (optional) Exclude this list of repos
+    excluded:
+      - my-namespace/excluded-repository-name
 # The gitlab section contains backup jobs for
 # GitLab.com and GitLab on premise
 gitlab:
@@ -64,6 +67,9 @@ gitlab:
     # your self-hosted gitlab install.
     # (default: https://gitlab.com/)
     url: https://gitlab.mydomain.com
+    # (optional) Exclude this list of repos
+    excluded:
+      - my-namespace/excluded-repository-name
 ```
 
 ## Usage: CLI

github.go

@@ -3,21 +3,24 @@ package git_backup
 import (
 	"context"
 	"fmt"
-	"github.com/google/go-github/v43/github"
-	"golang.org/x/oauth2"
 	"log"
 	"net/url"
+	"slices"
 	"strings"
+
+	"github.com/google/go-github/v43/github"
+	"golang.org/x/oauth2"
 )
 
 type GithubConfig struct {
-	JobName      string `yaml:"job_name"`
-	AccessToken  string `yaml:"access_token"`
-	URL          string `yaml:"url,omitempty"`
-	Starred      *bool  `yaml:"starred,omitempty"`
-	OrgMember    *bool  `yaml:"org_member,omitempty"`
-	Collaborator *bool  `yaml:"collaborator,omitempty"`
-	Owned        *bool  `yaml:"owned,omitempty"`
+	JobName      string   `yaml:"job_name"`
+	AccessToken  string   `yaml:"access_token"`
+	URL          string   `yaml:"url,omitempty"`
+	Starred      *bool    `yaml:"starred,omitempty"`
+	OrgMember    *bool    `yaml:"org_member,omitempty"`
+	Collaborator *bool    `yaml:"collaborator,omitempty"`
+	Owned        *bool    `yaml:"owned,omitempty"`
+	Exclude      []string `yaml:"exclude,omitempty"`
 	client       *github.Client
 }
 
@@ -39,16 +42,24 @@ func (c *GithubConfig) ListRepositories() ([]*Repository, error) {
 	if err != nil {
 		return nil, err
 	}
-	out := make([]*Repository, len(repos))
-	for i, repo := range repos {
+	out := make([]*Repository, 0, len(repos))
+	for _, repo := range repos {
 		gitUrl, err := url.Parse(*repo.CloneURL)
 		if err != nil {
 			return out, err
 		}
 		gitUrl.User = url.UserPassword("github", c.AccessToken)
-		out[i] = &Repository{
-			FullName: *repo.FullName,
-			GitURL:   *gitUrl,
+
+		isExcluded := slices.ContainsFunc(c.Exclude, func(s string) bool {
+			return strings.EqualFold(s, *repo.FullName)
+		})
+		if isExcluded {
+			log.Printf("Skipping excluded repository: %s", *repo.FullName)
+		} else {
+			out = append(out, &Repository{
+				FullName: *repo.FullName,
+				GitURL:   *gitUrl,
+			})
 		}
 	}
 	return out, nil

gitlab.go

@@ -1,18 +1,22 @@
 package git_backup
 
 import (
-	"github.com/xanzy/go-gitlab"
 	"log"
 	"net/url"
+	"slices"
+	"strings"
+
+	"github.com/xanzy/go-gitlab"
 )
 
 type GitLabConfig struct {
-	URL         string `yaml:"url,omitempty"`
-	JobName     string `yaml:"job_name"`
-	AccessToken string `yaml:"access_token"`
-	Starred     *bool  `yaml:"starred,omitempty"`
-	Member      *bool  `yaml:"member,omitempty"`
-	Owned       *bool  `yaml:"owned,omitempty"`
+	URL         string   `yaml:"url,omitempty"`
+	JobName     string   `yaml:"job_name"`
+	AccessToken string   `yaml:"access_token"`
+	Starred     *bool    `yaml:"starred,omitempty"`
+	Member      *bool    `yaml:"member,omitempty"`
+	Owned       *bool    `yaml:"owned,omitempty"`
+	Exclude     []string `yaml:"exclude,omitempty"`
 	client      *gitlab.Client
 }
 
@@ -64,7 +68,14 @@ func (g *GitLabConfig) ListRepositories() ([]*Repository, error) {
 
 	outSlice := make([]*Repository, 0, len(out))
 	for _, repository := range out {
-		outSlice = append(outSlice, repository)
+		isExcluded := slices.ContainsFunc(g.Exclude, func(s string) bool {
+			return strings.EqualFold(s, repository.FullName)
+		})
+		if isExcluded {
+			log.Printf("Skipping excluded repository: %s", repository.FullName)
+		} else {
+			outSlice = append(outSlice, repository)
+		}
 	}
 
 	return outSlice, nil

go.mod

@@ -1,6 +1,6 @@
 module git-backup
 
-go 1.17
+go 1.18
 
 require (
 	github.com/go-git/go-git/v5 v5.4.2