Makefile

@@ -69,9 +69,6 @@ test:
 	VIKUNJA_SERVICE_ROOTPATH=$(shell pwd) go test $(GOFLAGS) -cover -coverprofile cover.out $(PACKAGES)
 	go tool cover -html=cover.out -o cover.html
 
-required-gofmt-version:
-	@go version  | grep -q '\(1.7\|1.8\|1.9\|1.10\|1.11\)' || { echo "We require go version 1.7, 1.8, 1.9, 1.10 or 1.11 to format code" >&2 && exit 1; }
-
 .PHONY: lint
 lint:
 	@hash golint > /dev/null 2>&1; if [ $$? -ne 0 ]; then \
@@ -80,11 +77,11 @@ lint:
 	for PKG in $(PACKAGES); do golint -set_exit_status $$PKG || exit 1; done;
 
 .PHONY: fmt
-fmt: required-gofmt-version
+fmt:
 	$(GOFMT) -w $(GOFILES)
 
 .PHONY: fmt-check
-fmt-check: required-gofmt-version
+fmt-check:
 	# get all go files and run go fmt on them
 	@diff=$$($(GOFMT) -d $(GOFILES)); \
 	if [ -n "$$diff" ]; then \
@@ -93,10 +90,6 @@ fmt-check: required-gofmt-version
 		exit 1; \
 	fi;
 
-.PHONY: install
-install: $(wildcard *.go)
-	go install -v -tags '$(TAGS)' -ldflags '-s -w $(LDFLAGS)'
-
 .PHONY: build
 build: $(EXECUTABLE)
 
@@ -208,13 +201,6 @@ gocyclo-check:
 	fi
 	for S in $(GOFILES); do gocyclo -over 14 $$S || exit 1; done;
 
-.PHONY: gosimple-check
-gosimple-check:
-	@hash gosimple > /dev/null 2>&1; if [ $$? -ne 0 ]; then \
-		go get honnef.co/go/tools/cmd/gosimple; \
-	fi
-	for S in $(PACKAGES); do gosimple $$S || exit 1; done;
-
 .PHONY: static-check
 static-check:
 	@hash gocyclo > /dev/null 2>&1; if [ $$? -ne 0 ]; then \
@@ -222,13 +208,6 @@ static-check:
 	fi
 	staticcheck;
 
-.PHONY: unused-check
-unused-check:
-	@hash unused > /dev/null 2>&1; if [ $$? -ne 0 ]; then \
-		go get honnef.co/go/tools/cmd/unused; \
-	fi
-	unused;
-
 .PHONY: gosec-check
 gosec-check:
 	@hash ./bin/gosec > /dev/null 2>&1; if [ $$? -ne 0 ]; then \
@@ -242,4 +221,3 @@ goconst-check:
 		go get github.com/jgautheron/goconst/cmd/goconst; \
 	fi
 	for S in $(PACKAGES); do goconst $$S || exit 1; done;
-

README.md

@@ -21,6 +21,10 @@
 
 Try it under [try.vikunja.io](https://try.vikunja.io)!
 
+## Docs
+
+* [Development setup](docs/development-setup.md)
+
 ### Roadmap
 
 > I know, it's still a long way to go. I'm currently working on a lot of "basic" features, the exiting things will come later. Don't worry, they'll come.

docs/development-setup.md

@@ -5,6 +5,8 @@ If you don't intend to add new dependencies, go `1.9` and above should be fine.
 
 To contribute to Vikunja, fork the project and work on the master branch.
 
+A lot of developing tasks are automated using a Makefile, so make sure to [take a look at it](make.md).
+
 ### Libraries
 
 We keep all libraries used for Vikunja around in the `vendor/` folder to still be able to build the project even if

docs/make.md

@@ -0,0 +1,122 @@
+# Makefile
+
+We scripted a lot of tasks used mostly for developing into the makefile. This documents explains what
+taks are available and what they do.
+
+## CI
+
+These tasks are automatically run in our CI every time someone pushes to master or you update a pull request:
+
+* `make lint`
+* `make fmt-check`
+* `make ineffassign-check`
+* `make misspell-check`
+* `make goconst-check`
+* `make build`
+
+### clean
+
+```bash
+make clean
+```
+
+Clears all builds and binaries.
+
+### test
+
+```bash
+make test
+```
+
+Runs all tests in Vikunja.
+
+### Format the code
+
+```bash
+make fmt
+```
+
+Formats all source code using `go fmt`.
+
+#### Check formatting
+
+```bash
+make fmt-check
+```
+
+Checks if the code needs to be formatted. Fails if it does.
+
+### Build Vikunja
+
+```bash
+make build
+```
+
+Builds a `vikunja`-binary in the root directory of the repo for the platform it is run on.
+
+### Build Releases
+
+```bash
+make build
+```
+
+Builds binaries for all platforms and zips them with a copy of the `templates/` folder.
+All built zip files are stored into `dist/zips/`. Binaries are stored in `dist/binaries/`,
+binaries bundled with `templates` are stored in `dist/releases/`.
+
+All cross-platform binaries built using this series of commands are built with the help of 
+[xgo](https://github.com/karalabe/xgo). The make command will automatically install the
+binary to be able to use it.
+
+`make release` is actually just a shortcut to execute `make release-dirs release-windows release-linux release-darwin release-copy release-check release-os-package release-zip`.
+
+* `release-dirs` creates all directories needed
+* `release-windows`/`release-linux`/`release-darwin` execute xgo to build for their respective platforms
+* `release-copy` bundles binaries with a copy of `templates/` to then be zipped
+* `release-check` creates sha256 checksums for each binary which will be included in the zip file
+* `release-os-package` bundles a binary with a copy of the `templates/` folder, the `sha256` checksum file, a sample `config.yml` and a copy of the license in a folder for each architecture
+* `release-zip` makes a zip file for the files created by `release-os-package`
+
+### Build debian packages
+
+```bash
+make build-deb
+```
+
+Will build a `.deb` package into the current folder. You need to have [fpm](https://fpm.readthedocs.io/en/latest/intro.html) installed to be able to do this.
+
+#### Make a debian repo
+
+```bash
+make reprepro
+```
+
+Takes an already built debian package and creates a debian repo structure around it.
+
+Used to be run inside a [docker container](https://git.kolaente.de/konrad/reprepro-docker) in the CI process when releasing.
+
+### Generate swagger definitions from code comments
+
+```bash
+make do-the-swag
+```
+
+Generates swagger definitions from the comments in the code.
+
+#### Check if swagger generation is needed
+
+```bash
+make got-swag
+```
+
+This command is currently more an experiment, use it with caution.
+It may bring up wrong results.
+
+### Code-Checks
+
+* `misspell-check`: Checks for commonly misspelled words
+* `ineffassign-check`: Checks for ineffectual assignments in the code using [ineffassign](https://github.com/gordonklaus/ineffassign).
+* `gocyclo-check`: Calculates cyclomatic complexities of functions using [gocyclo](https://github.com/fzipp/gocyclo).
+* `static-check`: Analyzes the code for bugs, improvements and more using [staticcheck](https://staticcheck.io/docs/).
+* `gosec-check`: Inspects source code for security problems by scanning the Go AST using the [gosec tool](https://github.com/securego/gosec).
+* `goconst-check`: Finds repeated strings that could be replaced by a constant using [goconst](https://github.com/jgautheron/goconst/).

tools.go

@@ -30,7 +30,5 @@ import (
 	_ "golang.org/x/lint/golint"
 
 	_ "github.com/jgautheron/goconst/cmd/goconst"
-	_ "honnef.co/go/tools/cmd/gosimple"
 	_ "honnef.co/go/tools/cmd/staticcheck"
-	_ "honnef.co/go/tools/cmd/unused"
 )