feat: exclude branches.

Author: ldez

core/core.go

@@ -66,7 +66,7 @@ func process(workDir string, config *types.Configuration) error {
 
 	log.Printf("Latest tag: %s", latestTagName)
 
-	branches, err := getBranches(config.ExperimentalBranchName, config.Debug)
+	branches, err := getBranches(config.ExperimentalBranchName, config.ExcludedBranches, config.Debug)
 	if err != nil {
 		return err
 	}
@@ -129,7 +129,7 @@ func getLatestReleaseTagName(owner, repositoryName string) (string, error) {
 	return gh.GetLatestReleaseTagName(owner, repositoryName)
 }
 
-func getBranches(experimentalBranchName string, debug bool) ([]string, error) {
+func getBranches(experimentalBranchName string, excludedBranches []string, debug bool) ([]string, error) {
 	var branches []string
 
 	if len(experimentalBranchName) > 0 {
@@ -140,7 +140,14 @@ func getBranches(experimentalBranchName string, debug bool) ([]string, error) {
 	if err != nil {
 		return nil, err
 	}
-	branches = append(branches, gitBranches...)
+
+	for _, branch := range gitBranches {
+		if containsBranch(excludedBranches, branch) {
+			continue
+		}
+
+		branches = append(branches, branch)
+	}
 
 	if len(branches) == 0 {
 		log.Println("[WARN] no branch.")
@@ -149,6 +156,16 @@ func getBranches(experimentalBranchName string, debug bool) ([]string, error) {
 	return branches, nil
 }
 
+func containsBranch(branches []string, branch string) bool {
+	for _, v := range branches {
+		if baseRemote+v == branch {
+			return true
+		}
+	}
+
+	return false
+}
+
 func createSiteDirectory() (string, error) {
 	currentDir, err := os.Getwd()
 	if err != nil {

core/core_test.go

@@ -2,11 +2,14 @@ package core
 
 import (
 	"io/ioutil"
+	"log"
 	"os"
 	"path/filepath"
+	"strings"
 	"testing"
 
 	"github.com/containous/structor/types"
+	"github.com/ldez/go-git-cmd-wrapper/git"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -220,3 +223,67 @@ func Test_createDirectory(t *testing.T) {
 		})
 	}
 }
+
+func Test_getBranches(t *testing.T) {
+	git.CmdExecutor = func(name string, debug bool, args ...string) (string, error) {
+		if debug {
+			log.Println(name, strings.Join(args, " "))
+		}
+		return `
+  origin/v1.3
+  origin/v1.1
+  origin/v1.2
+`, nil
+	}
+
+	testCases := []struct {
+		desc                   string
+		experimentalBranchName string
+		excludedBranches       []string
+		expected               []string
+	}{
+		{
+			desc: "all existing branches",
+			expected: []string{
+				"origin/v1.3",
+				"origin/v1.2",
+				"origin/v1.1",
+			},
+		},
+		{
+			desc:                   "add experimental branch",
+			experimentalBranchName: "master",
+			expected: []string{
+				"origin/master",
+				"origin/v1.3",
+				"origin/v1.2",
+				"origin/v1.1",
+			},
+		},
+		{
+			desc:             "exclude one branch",
+			excludedBranches: []string{"v1.1"},
+			expected: []string{
+				"origin/v1.3",
+				"origin/v1.2",
+			},
+		},
+		{
+			desc:             "exclude all branches",
+			excludedBranches: []string{"v1.1", "v1.2", "v1.3"},
+			expected:         nil,
+		},
+	}
+
+	for _, test := range testCases {
+		test := test
+		t.Run(test.desc, func(t *testing.T) {
+			t.Parallel()
+
+			branches, err := getBranches(test.experimentalBranchName, test.excludedBranches, true)
+			require.NoError(t, err)
+
+			assert.Equal(t, test.expected, branches)
+		})
+	}
+}

types/types.go

@@ -11,6 +11,7 @@ type Configuration struct {
 	DockerfileURL          string     `short:"d" long:"dockerfile-url" description:"Use this Dockerfile when --dockerfile-name is not found. Can be a file path. [required]"`
 	DockerfileName         string     `long:"dockerfile-name" description:"Search and use this Dockerfile in the repository (in './docs/' or in './') for building documentation."`
 	ExperimentalBranchName string     `long:"exp-branch" description:"Build a branch as experimental."`
+	ExcludedBranches       []string   `long:"exclude" description:"Exclude branches from the documentation generation."`
 	DockerImageName        string     `long:"image-name" description:"Docker image name."`
 	Menu                   *MenuFiles `long:"menu" description:"Menu templates files."`
 	RequirementsURL        string     `long:"rqts-url" description:"Use this requirements.txt to merge with the current requirements.txt. Can be a file path."`