diff --git a/docs/dev/releases.md b/docs/dev/releases.md index ce613cc23..7ce3f4ac4 100644 --- a/docs/dev/releases.md +++ b/docs/dev/releases.md @@ -9,17 +9,17 @@ requirements you can build a raw server binary, a local container image, or push an image to a remote repository. Build a raw server binary -```console +```shell $ make controller ``` Build a local container image -```console +```shell $ make container TAG=0.0 PREFIX=$USER/ingress-controller ``` Push the container image to a remote repository -```console +```shell $ make push TAG=0.0 PREFIX=$USER/ingress-controller ``` @@ -28,7 +28,7 @@ $ make push TAG=0.0 PREFIX=$USER/ingress-controller The build should use dependencies in the `ingress/vendor` directory. Occasionally, you might need to update the dependencies. -```console +```shell $ godep version godep v74 (linux/amd64/go1.6.1) $ go version @@ -36,12 +36,12 @@ go version go1.6.1 linux/amd64 ``` This will automatically save godeps to `vendor/` -```console +```shell $ godep save ./... ``` If you have an older version of `godep` -```console +```shell $ go get github.com/tools/godep $ cd $GOPATH/src/github.com/tools/godep $ go build -o godep *.go @@ -49,7 +49,7 @@ $ go build -o godep *.go In general, you can follow [this guide](https://github.com/kubernetes/kubernetes/blob/release-1.5/docs/devel/godep.md#using-godep-to-manage-dependencies) to update godeps. To update a particular dependency, eg: Kubernetes: -```console +```shell cd $GOPATH/src/github.com/kubernetes/ingress godep restore go get -u github.com/kubernetes/kubernetes @@ -64,19 +64,23 @@ git commit ## Testing -To run unittets, enter each directory in `controllers/` -```console +See also [related FAQs](../faq#how-are-the-ingress-controllers-tested). + +### Unit tests + +To run unit tests, enter each directory in `controllers/` +```shell $ cd $GOPATH/src/k8s.io/ingress/controllers/gce $ go test ./... ``` -If you have access to a Kubernetes cluster, you can also run e2e tests -```console -$ cd $GOPATH/src/k8s.io/kubernetes -$ ./hack/ginkgo-e2e.sh --ginkgo.focus=Ingress.* --delete-namespace-on-failure=false -``` +### e2e tests -See also [related FAQs](../faq#how-are-the-ingress-controllers-tested). +If you have access to a Kubernetes cluster, you can also run e2e tests +```shell +$ cd $GOPATH/src/k8s.io/kubernetes +$ go run hack/e2e.go -- -v --test --test_args="--ginkgo.focus=Ingress.* --delete-namespace-on-failure=false" +``` [TODO](https://github.com/kubernetes/ingress/issues/5): add instructions on running integration tests, or e2e against local-up/minikube.