Skip to content

Commit

Permalink
updates makefile and readme (#1310)
Browse files Browse the repository at this point in the history
  • Loading branch information
vinitparekh17 authored Nov 22, 2024
1 parent 12676ee commit ad3eb90
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 22 deletions.
20 changes: 12 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Adapted from https://www.thapaliya.com/en/writings/well-documented-makefiles/

THREADS ?= 4 #number of threads
CLIENTS ?= 50 #number of clients per thread
REQUESTS ?= 10000 #number of requests per client
Expand Down Expand Up @@ -43,13 +45,6 @@ unittest: ## run the unit tests
unittest-one: ## run a single unit test function by name (e.g. make unittest-one TEST_FUNC=TestSetGet)
go test -v -race -count=1 --run $(TEST_FUNC) ./internal/...

release: ## build and push the Docker image to Docker Hub with the latest tag and the version tag
git tag $(VERSION)
git push origin --tags
docker build --tag dicedb/dicedb:latest --tag dicedb/dicedb:$(VERSION) .
docker push dicedb/dicedb:$(VERSION)
docker push dicedb/dicedb:latest

##@ Benchmarking

run_benchmark: ## run the memtier benchmark with the specified parameters
Expand Down Expand Up @@ -96,4 +91,13 @@ check-golangci-lint:
clean: ## clean the dicedb binary
@echo "Cleaning build artifacts..."
rm -f dicedb
@echo "Clean complete."
@echo "Clean complete."

##@ Deployment

release: ## build and push the Docker image to Docker Hub with the latest tag and the version tag
git tag $(VERSION)
git push origin --tags
docker build --tag dicedb/dicedb:latest --tag dicedb/dicedb:$(VERSION) .
docker push dicedb/dicedb:$(VERSION)
docker push dicedb/dicedb:latest
15 changes: 1 addition & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,19 +105,6 @@ By default, DiceDB will look for the configuration file at `./dicedb.conf`. (Lin

> [!TIP]
> If you want to use a custom configuration file, you can specify the path using the `-c` flag. and to output the configuration file to a specific location, you can specify the output dir path using the `-o` flag.
#### Additional Configuration Options:

If you'd like to use a different location, you can specify a custom configuration file path with the `-c flag`:

```bash
go run main.go -c /path/to/config.toml
```
If you'd like to output the configuration file to a specific location, you can specify a custom output path with the `-o flag`:

```bash
go run main.go -o /path/of/output/dir
```

### Setting up CLI

Expand Down Expand Up @@ -222,4 +209,4 @@ Contributors can join the [Discord Server](https://discord.gg/6r8uXWtXh7) for qu
```
$ sudo netstat -atlpn | grep :7379
$ sudo kill -9 <process_id>
```
```

0 comments on commit ad3eb90

Please sign in to comment.