feat: branch and tag filters

Author: saitho

README.md

@@ -85,14 +85,16 @@ files:
 
 In the `display` section you can define how the frontend should look like.
 
-You may change the `order` of tags or hide the tag date in `tags` subsection.
-
-You can also toggle the display of branches or tags for the index page in the `index` subsection.
-
 ```yaml
 ---
 display:
+  branches:
+     filter:
+        - master
+        - develop
+        - /feature/.*/ # regex: any feature branches
   tags:
+    filter: []
     order: desc
     show_date: true
     virtual_tags:
@@ -102,19 +104,34 @@ display:
     show_tags: true
 ```
 
+You may change the `order` of tags or hide the tag date in `tags` subsection.
+
+You can also toggle the display of branches or tags for the index page in the `index` subsection.
+
 #### Virtual tags
 
 Virtual major tags will always point to the latest version inside a major release.
 They can be enabled by setting `display.tags.virtual_tags.enable_semver_major` to true.
 
 This only will consider semantic versions.
 
-_Example:_ Given the versions v1.0.0, v1.1.0, v2.0.0, two virtual tags "v1" and "v2" will be displayed.
+_Example:_ Given the tags v1.0.0, v1.1.0, v2.0.0, two virtual tags "v1" and "v2" will be displayed.
 "v1" links to "v1.1.0" and "v2" links to "v2.0.0".
 Pushing a release "v2.0.1" will make "v2" automatically refer to "v2.0.1".
 
 This also works when you don't use the "v" prefix in your tags. The virtual tag will then also not have a "v" prefix.
 
+#### Filters
+
+Using the `filter` settings in _branches_ and _tags_ subsection you can filter which branches or tags should be displayed.
+Wrap the string in / to evaluate the inside as Golang regular expression.
+
+Note that the filters apply before the virtual tags.
+Given the repostory has two tags v1.0.0 and v1.1.0.
+For some reason, you exclude v1.1.0 via a filter.
+The virtual tag will then point to v1.0.0, not v1.1.0!
+
+
 ## Mirroring with Webhooks
 
 If you want to update the repository whenever something is pushed or tagged in your repository, you can use GitHub webhooks.

config.yml.dist

@@ -12,6 +12,11 @@ git:
 files:
   - "**/*.json"
 display:
+  branches:
+    filter:
+      - master
+      - develop
+      - /feature/.*/ # regex: any feature branches
   tags:
     order: desc
     show_date: true

config/config.go

@@ -31,7 +31,11 @@ type Config struct {
 		}
 	}
 	Display struct {
+		Branches struct {
+			Filter []string
+		}
 		Tags struct {
+			Filter      []string
 			Order       string `default:"desc" yaml:"order"`
 			ShowDate    bool   `default:"true" yaml:"show_date"`
 			VirtualTags struct {

git/repo.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"io/ioutil"
 	"os"
+	"regexp"
 	"strconv"
 	"strings"
 	"time"
@@ -53,6 +54,62 @@ func (g *GitHandler) IsUpToDate() bool {
 	return time.Now().Unix() <= (g.GetUpdatedTime() + int64(g.Cfg.Git.Update.Cache.Time))
 }
 
+func (g *GitHandler) filterBranches(references []string) []string {
+	filters := g.Cfg.Display.Branches.Filter
+	if len(filters) == 0 {
+		return references
+	}
+	var output []string
+	for _, v := range references {
+		valid := false
+		for _, f := range filters {
+			if strings.HasPrefix(f, "/") && strings.HasSuffix(f, "/") {
+				// RegEx
+				expression := strings.Trim(f, "/")
+				valid = regexp.MustCompile(expression).MatchString(v)
+			} else {
+				valid = f == v
+			}
+			if valid {
+				break
+			}
+		}
+		if !valid {
+			continue
+		}
+		output = append(output, v)
+	}
+	return output
+}
+
+func (g *GitHandler) filterTags(references []GitTag) []GitTag {
+	filters := g.Cfg.Display.Tags.Filter
+	if len(filters) == 0 {
+		return references
+	}
+	var output []GitTag
+	for _, v := range references {
+		valid := false
+		for _, f := range filters {
+			if strings.HasPrefix(f, "/") && strings.HasSuffix(f, "/") {
+				// RegEx
+				expression := strings.Trim(f, "/")
+				valid = regexp.MustCompile(expression).MatchString(v.Tag)
+			} else {
+				valid = f == v.Tag
+			}
+			if valid {
+				break
+			}
+		}
+		if !valid {
+			continue
+		}
+		output = append(output, v)
+	}
+	return output
+}
+
 func (g *GitHandler) GetBranches() []string {
 	output, _ := g.runGitCommand("branch", "-l", "-r", "--no-color")
 	var branches []string
@@ -61,7 +118,7 @@ func (g *GitHandler) GetBranches() []string {
 		v = strings.TrimPrefix(v, "origin/")
 		branches = append(branches, v)
 	}
-	return branches
+	return g.filterBranches(branches)
 }
 
 type GitTag struct {
@@ -83,5 +140,6 @@ func (g *GitHandler) GetTags() []GitTag {
 			Date: intDate,
 		})
 	}
-	return tags
+
+	return g.filterTags(tags)
 }