Coding¶

Dependencies¶

• dep

We use dep for dependency management and pining.

Getting Started¶

Clone the repository:

cd $PATH_TO_YOUR_GOPATH/src/github.com
git clone https://github.com/testthedocs/redactor.git

Code Blueprint¶

redactor is based on cobra.

We inject the version number, the build date and the git hash via ldflags during package build into version.go (cmd/version.go).

See the example below for how we do that in the Makefile (for local test installs).

.PHONY: install
install: ## Creating test builds (binaries) for local testing
           go install -ldflags "$(LD_FLAGS) -X main.Version=${VERSION} \
            -X github.com/testthedocs/redactor/cmd.BuildTime=$(BUILD_DATE)"