Skip to content

Commit 4040093

Browse files
denglimingdengliming
authored
Merge remote branch 'master'
Merge remote branch 'master'
2 parents 4df59e0 + 9b1ea70 commit 4040093

File tree

6 files changed

+118
-5
lines changed

6 files changed

+118
-5
lines changed

‎.circleci/config.yml‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,7 @@ jobs:
1414
working_directory: /go/src/github.com/RedisBloom/redisbloom-go
1515
steps:
1616
- checkout
17-
- run: go get -v -t -d ./...
18-
19-
#run tests with coverage
17+
- run: make checkfmt
2018
- run: make get
2119
- run: make coverage
2220
- run: bash <(curl -s https://codecov.io/bash) -t ${CODECOV_TOKEN}

‎.github/release-drafter-config.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name-template: 'Version $NEXT_PATCH_VERSION - Summary Here🌈'
2+
tag-template: 'v$NEXT_PATCH_VERSION'
3+
categories:
4+
- title: '🚀Features'
5+
labels:
6+
- 'feature'
7+
- 'enhancement'
8+
- title: 'Bug Fixes'
9+
labels:
10+
- 'fix'
11+
- 'bugfix'
12+
- 'bug'
13+
- title: '🧰Maintenance'
14+
label: 'chore'
15+
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
16+
exclude-labels:
17+
- 'skip-changelog'
18+
template: |
19+
## Changes
20+
21+
$CHANGES

‎.github/workflows/release-drafter.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Release Drafter
2+
3+
on:
4+
push:
5+
# branches to consider in the event; optional, defaults to all
6+
branches:
7+
- master
8+
9+
jobs:
10+
update_release_draft:
11+
runs-on: ubuntu-latest
12+
steps:
13+
# Drafts your next Release notes as Pull Requests are merged into "master"
14+
- uses: release-drafter/release-drafter@v5
15+
with:
16+
# (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
17+
config-name: release-drafter-config.yml
18+
env:
19+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.golangci.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# options for analysis running
2+
run:
3+
# include test files or not, default is true
4+
tests: false
5+
6+
linters-settings:
7+
golint:
8+
# minimal confidence for issues, default is 0.8
9+
min-confidence: 0.8
10+
11+
exclude-rules:
12+
# Exclude some linters from running on tests files.
13+
- path: _test\.go
14+
linters:
15+
- errcheck

‎Makefile‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,25 @@ GOCLEAN=$(GOCMD) clean
66
GOTEST=$(GOCMD) test
77
GOGET=$(GOCMD) get
88
GOMOD=$(GOCMD) mod
9+
GOFMT=$(GOCMD) fmt
910

1011
.PHONY: all test coverage
1112
all: test coverage
1213

14+
checkfmt:
15+
@echo 'Checking gofmt';\
16+
bash -c "diff -u <(echo -n) <(gofmt -d .)";\
17+
EXIT_CODE=$$?;\
18+
if [ "$$EXIT_CODE" -ne 0 ]; then \
19+
echo '$@: Go files must be formatted with gofmt'; \
20+
fi && \
21+
exit $$EXIT_CODE
22+
1323
get:
1424
$(GOGET) -t -v ./...
1525

1626
test: get
27+
$(GOFMT) ./...
1728
$(GOTEST) -race -covermode=atomic ./...
1829

1930
coverage: get test

‎README.md‎

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,59 @@ func main() {
5555

5656
## Supported RedisBloom Commands
5757

58+
### Bloom Filter
59+
60+
| Command | Recommended API and godoc |
61+
| :--- | ----: |
62+
| [BF.RESERVE](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfreserve) | [Reserve](https://godoc.org/github.com/RedisBloom/redisbloom-go#Client.Reserve) |
63+
| [BF.ADD](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfadd) | [Add](https://godoc.org/github.com/RedisBloom/redisbloom-go#Client.Add) |
64+
| [BF.MADD](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfmadd) | N/A |
65+
| [BF.INSERT](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfinsert) | N/A |
66+
| [BF.EXISTS](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfexists) | [Exists](https://godoc.org/github.com/RedisBloom/redisbloom-go#Client.Exists) |
67+
| [BF.MEXISTS](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfmexists) | N/A |
68+
| [BF.SCANDUMP](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfscandump) | N/A |
69+
| [BF.LOADCHUNK](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfloadchunk) | N/A |
70+
| [BF.INFO](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfinfo) | [Info](https://godoc.org/github.com/RedisBloom/redisbloom-go#Client.Info) |
71+
72+
### Cuckoo Filter
73+
74+
| Command | Recommended API and godoc |
75+
| :--- | ----: |
76+
| [CF.RESERVE](https://oss.redislabs.com/redisbloom/Cuckoo_Commands/#cfreserve) | N/A |
77+
| [CF.ADD](https://oss.redislabs.com/redisbloom/Cuckoo_Commands/#cfadd) | N/A |
78+
| [CF.ADDNX](https://oss.redislabs.com/redisbloom/Cuckoo_Commands/#cfaddnx) | N/A |
79+
| [CF.INSERT](https://oss.redislabs.com/redisbloom/Cuckoo_Commands/#cfinsert) | N/A |
80+
| [CF.INSERTNX](https://oss.redislabs.com/redisbloom/Cuckoo_Commands/#cfinsertnx) | N/A |
81+
| [CF.EXISTS](https://oss.redislabs.com/redisbloom/Cuckoo_Commands/#cfexists) | N/A |
82+
| [CF.DEL](https://oss.redislabs.com/redisbloom/Cuckoo_Commands/#cfdel) | N/A |
83+
| [CF.COUNT](https://oss.redislabs.com/redisbloom/Cuckoo_Commands/#cfcount) | N/A |
84+
| [CF.SCANDUMP](https://oss.redislabs.com/redisbloom/Cuckoo_Commands/#cfscandump) | N/A |
85+
| [CF.LOADCHUNK](https://oss.redislabs.com/redisbloom/Cuckoo_Commands/#cfloadchunck) | N/A |
86+
| [CF.INFO](https://oss.redislabs.com/redisbloom/Cuckoo_Commands/#cfinfo) | N/A |
87+
88+
### Count-Min Sketch
89+
90+
| Command | Recommended API and godoc |
91+
| :--- | ----: |
92+
| [CMS.INITBYDIM](https://oss.redislabs.com/redisbloom/CountMinSketch_Commands/#cmsinitbydim) | N/A |
93+
| [CMS.INITBYPROB](https://oss.redislabs.com/redisbloom/CountMinSketch_Commands/#cmsinitbyprob) | N/A |
94+
| [CMS.INCRBY](https://oss.redislabs.com/redisbloom/CountMinSketch_Commands/#cmsincrby) | N/A |
95+
| [CMS.QUERY](https://oss.redislabs.com/redisbloom/CountMinSketch_Commands/#cmsquery) | N/A |
96+
| [CMS.MERGE](https://oss.redislabs.com/redisbloom/CountMinSketch_Commands/#cmsmerge) | N/A |
97+
| [CMS.INFO](https://oss.redislabs.com/redisbloom/CountMinSketch_Commands/#cmsinfo) | N/A |
98+
99+
### TopK Filter
100+
58101
| Command | Recommended API and godoc |
59102
| :--- | ----: |
60-
| [BF.ADD](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfadd) | |
61-
| [BF.EXISTS](https://oss.redislabs.com/redisbloom/Bloom_Commands/#bfexists) | |
103+
| [TOPK.RESERVE](https://oss.redislabs.com/redisbloom/TopK_Commands/#topkreserve) | N/A |
104+
| [TOPK.ADD](https://oss.redislabs.com/redisbloom/TopK_Commands/#topkadd) | N/A |
105+
| [TOPK.INCRBY](https://oss.redislabs.com/redisbloom/TopK_Commands/#topkincrby) | N/A |
106+
| [TOPK.QUERY](https://oss.redislabs.com/redisbloom/TopK_Commands/#topkquery) | N/A |
107+
| [TOPK.COUNT](https://oss.redislabs.com/redisbloom/TopK_Commands/#topkcount) | N/A |
108+
| [TOPK.LIST](https://oss.redislabs.com/redisbloom/TopK_Commands/#topklist) | N/A |
109+
| [TOPK.INFO](https://oss.redislabs.com/redisbloom/TopK_Commands/#topkinfo) | N/A |
110+
62111

63112
## License
64113

0 commit comments

Comments
 (0)