Skip to content

Commit 5f4af2c

Browse files
authored
doc/dev/developer_guide.md: update dev guide (#740)
* doc/dev/developer_guide.md: update dev guide
1 parent d2961c3 commit 5f4af2c

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

doc/dev/developer_guide.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,38 +2,58 @@
22

33
This document explains how to setup your dev environment.
44

5+
## Prerequisites
6+
- [dep][dep_tool] version v0.5.0+
7+
- [git][git_tool]
8+
- [go][go_tool] version v1.10+
9+
510
## Download Operator SDK
611

7-
Go to https://github.com/operator-framework/operator-sdk and follow the [fork guide][fork_guide] to fork, clone, and setup the local operator-sdk repository.
12+
Go to the [Operator SDK repo][repo_sdk] and follow the [fork guide][fork_guide] to fork, clone, and setup the local operator-sdk repository.
813

914
## Vendor dependencies
1015

11-
We use [dep](https://github.com/golang/dep) to manage dependencies.
1216
Run the following in the project root directory to update the vendored dependencies:
1317

1418
```sh
1519
$ cd $GOPATH/src/github.com/operator-framework/operator-sdk
16-
$ dep ensure
20+
$ make dep
1721
```
1822

1923
## Build the Operator SDK CLI
2024

21-
Requirement:
22-
- Go 1.9+
23-
2425
Build the Operator SDK CLI `operator-sdk` binary:
2526

2627
```sh
27-
# TODO: replace this with the ./build script.
28-
$ go install github.com/operator-framework/operator-sdk/commands/operator-sdk
28+
$ make install
2929
```
3030

3131
## Testing
3232

3333
Run unit tests:
3434

3535
```sh
36-
TODO: use ./test script
36+
$ make test/unit
37+
```
38+
39+
Run all tests:
40+
41+
```sh
42+
$ make test
3743
```
3844

39-
[fork_guide]:https://help.github.com/articles/fork-a-repo/
45+
**Note:** running all tests requires:
46+
- [docker][docker_tool] version 17.03+
47+
- [kubectl][kubectl_tool] version v1.11.0+
48+
- Access to a kubernetes v.1.11.0+ cluster
49+
50+
See the project [README][sdk_readme] for more details.
51+
52+
[dep_tool]:https://golang.github.io/dep/docs/installation.html
53+
[git_tool]:https://git-scm.com/downloads
54+
[go_tool]:https://golang.org/dl/
55+
[repo_sdk]:https://github.com/operator-framework/operator-sdk
56+
[fork_guide]:https://help.github.com/articles/fork-a-repo/
57+
[docker_tool]:https://docs.docker.com/install/
58+
[kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
59+
[sdk_readme]:../../README.md

0 commit comments

Comments
 (0)