Merge pull request #14 from RedisBloom/gofmt.and.release.drafter

Added gofmt automation/check. Added release drafter github action.

Author: filipecosta90

.circleci/config.yml

@@ -14,9 +14,7 @@ jobs:
     working_directory: /go/src/github.com/RedisBloom/redisbloom-go
     steps:
       - checkout
-      - run: go get -v -t -d ./...
-
-      #run tests with coverage
+      - run: make checkfmt
       - run: make get
       - run: make coverage
       - run: bash <(curl -s https://codecov.io/bash) -t ${CODECOV_TOKEN}

.github/release-drafter-config.yml

@@ -0,0 +1,21 @@
+name-template: 'Version $NEXT_PATCH_VERSION - Summary Here🌈'
+tag-template: 'v$NEXT_PATCH_VERSION'
+categories:
+  - title: '🚀Features'
+    labels:
+      - 'feature'
+      - 'enhancement'
+  - title: 'Bug Fixes'
+    labels:
+      - 'fix'
+      - 'bugfix'
+      - 'bug'
+  - title: '🧰Maintenance'
+    label: 'chore'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+exclude-labels:
+  - 'skip-changelog'
+template: |
+  ## Changes
+
+  $CHANGES

.github/workflows/release-drafter.yml

@@ -0,0 +1,19 @@
+name: Release Drafter
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - master
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - uses: release-drafter/release-drafter@v5
+        with:
+          # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
+           config-name: release-drafter-config.yml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.golangci.yml

@@ -0,0 +1,15 @@
+# options for analysis running
+run:
+  # include test files or not, default is true
+  tests: false
+
+linters-settings:
+  golint:
+    # minimal confidence for issues, default is 0.8
+    min-confidence: 0.8
+
+exclude-rules:
+  # Exclude some linters from running on tests files.
+  - path: _test\.go
+    linters:
+      - errcheck

Makefile

@@ -6,14 +6,25 @@ GOCLEAN=$(GOCMD) clean
 GOTEST=$(GOCMD) test
 GOGET=$(GOCMD) get
 GOMOD=$(GOCMD) mod
+GOFMT=$(GOCMD) fmt
 
 .PHONY: all test coverage
 all: test coverage
 
+checkfmt:
+	@echo 'Checking gofmt';\
+ 	bash -c "diff -u <(echo -n) <(gofmt -d .)";\
+	EXIT_CODE=$$?;\
+	if [ "$$EXIT_CODE"  -ne 0 ]; then \
+		echo '$@: Go files must be formatted with gofmt'; \
+	fi && \
+	exit $$EXIT_CODE
+
 get:
 	$(GOGET) -t -v ./...
 
 test: get
+	$(GOFMT) ./...
 	$(GOTEST) -race -covermode=atomic ./...
 
 coverage: get test

client.go

@@ -44,11 +44,11 @@ func NewClientFromPool(pool *redis.Pool, name string) *Client {
 	return ret
 }
 
-// Reserve - Creates an empty Bloom Filter with a given desired error ratio and initial capacity. 
+// Reserve - Creates an empty Bloom Filter with a given desired error ratio and initial capacity.
 // args:
 // key - the name of the filter
 // error_rate - the desired probability for false positives
-// capacity - the number of entries you intend to add to the filter 
+// capacity - the number of entries you intend to add to the filter
 func (client *Client) Reserve(key string, error_rate float64, capacity uint64) (err error) {
 	conn := client.Pool.Get()
 	defer conn.Close()
@@ -58,27 +58,27 @@ func (client *Client) Reserve(key string, error_rate float64, capacity uint64) (
 
 // Add - Add (or create and add) a new value to the filter
 // args:
-// key - the name of the filter 
-// item - the item to add 
+// key - the name of the filter
+// item - the item to add
 func (client *Client) Add(key string, item string) (exists bool, err error) {
 	conn := client.Pool.Get()
 	defer conn.Close()
 	return redis.Bool(conn.Do("BF.ADD", key, item))
 }
 
-// Exists - Determines whether an item may exist in the Bloom Filter or not. 
+// Exists - Determines whether an item may exist in the Bloom Filter or not.
 // args:
-// key - the name of the filter 
-// item - the item to check for 
+// key - the name of the filter
+// item - the item to check for
 func (client *Client) Exists(key string, item string) (exists bool, err error) {
 	conn := client.Pool.Get()
 	defer conn.Close()
 	return redis.Bool(conn.Do("BF.EXISTS", key, item))
 }
 
-// Info - Return information about key  
+// Info - Return information about key
 // args:
-// key - the name of the filter 
+// key - the name of the filter
 func (client *Client) Info(key string) (info map[string]int64, err error) {
 	conn := client.Pool.Get()
 	defer conn.Close()