Skip to content

Commit 6e02855

Browse files
committed
doc/dev: removing references to dep for building and testing the SDK repo
1 parent 6a3d0ee commit 6e02855

File tree

6 files changed

+23
-12
lines changed

6 files changed

+23
-12
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ The following workflow is for a new **Helm** operator:
3838

3939
## Prerequisites
4040

41-
- [dep][dep_tool] version v0.5.0+.
4241
- [git][git_tool]
4342
- [go][go_tool] version v1.12+.
4443
- [docker][docker_tool] version 17.03+.
4544
- Alternatively [podman][podman_tool] `v1.2.0+` or [buildah][buildah_tool] `v1.7+`
4645
- [kubectl][kubectl_tool] version v1.11.3+.
4746
- Access to a Kubernetes v1.11.3+ cluster.
48-
- Optional: [`delve`](https://github.com/go-delve/delve/tree/master/Documentation/installation) version 1.2.0+ (for `up local --enable-delve`).
47+
- Optional: [dep][dep_tool] version v0.5.0+.
48+
- Optional: [delve](https://github.com/go-delve/delve/tree/master/Documentation/installation) version 1.2.0+ (for `up local --enable-delve`).
4949

5050
## Quick Start
5151

doc/dev/developer_guide.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
This document explains how to setup your dev environment.
44

55
## Prerequisites
6-
- [dep][dep_tool] version v0.5.0+
76
- [git][git_tool]
87
- [go][go_tool] version v1.12+
98

@@ -49,7 +48,6 @@ refer to the [`Running the Tests Locally`][running-the-tests] document.
4948

5049
See the project [README][sdk_readme] for more details.
5150

52-
[dep_tool]:https://golang.github.io/dep/docs/installation.html
5351
[git_tool]:https://git-scm.com/downloads
5452
[go_tool]:https://golang.org/dl/
5553
[repo_sdk]:https://github.com/operator-framework/operator-sdk

doc/dev/testing/running-the-tests.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,18 @@ $ eval $(minikube docker-env)
7777

7878
All the tests are run through the [`Makefile`][makefile]. This is a brief description of all makefile test instructions:
7979

80-
- `test` - Installs `operator-sdk` by running `dep ensure` and `make install`, and then runs all tests. This is intended as a full test for developers.
81-
- `test/ci-go` - Runs all the tests that the Go job runs in CI (`sanity`, `unit`, `subcommand`, `e2e/go`).
82-
- `test/ci-ansible` - Runs all the tests that the Ansible job runs in CI (`e2e/ansible`).
80+
- `test` - Runs the unit tests.
81+
- `test-ci` - Runs markdown, sanity, and unit tests, installs the SDK binary, and runs the SDK subcommand and all E2E tests.
82+
- `test/ci-go` - Runs all the tests that the Go job runs in CI (`subcommand` and `e2e/go`).
83+
- `test/ci-ansible` - Runs all the tests that the Ansible job runs in CI (`e2e/ansible` and `e2e/ansible-molecule`).
8384
- `test/ci-helm` - Runs all the tests that the Helm job runs in CI (`e2e/helm`).
8485
- `test/sanity` - Runs sanity checks.
8586
- `test/unit` - Runs unit tests.
8687
- `test/subcommand` - Runs subcommand tests.
87-
- `test/e2e` - Runs all E2E tests (`e2e/go`, `e2e/ansible`, and `e2e/helm`).
88+
- `test/e2e` - Runs all E2E tests (`e2e/go`, `e2e/ansible`, `e2e/ansible-molecule`, and `e2e/helm`).
8889
- `test/e2e/go` - Runs the go E2E test.
8990
- `test/e2e/ansible` - Runs the ansible E2E test.
91+
- `test/e2e/ansible-molecule` - Runs the ansible molecule tests.
9092
- `test/e2e/helm` - Runs the helm E2E test.
9193
- `test/markdown` - Runs the markdown checks
9294

doc/dev/testing/travis-build.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ For the Go, Ansible, and Helm tests, the `before_install` and `install` stages a
1818

1919
1. Check if non documentation files have been updated.
2020
- If only documentation has been updated, skip these tests.
21-
2. Download dep and run `dep ensure`.
21+
2. Run `make tidy` to ensure `go.mod` and `go.sum` are up-to-date.
2222
3. Build and install the sdk using `make install`.
2323
4. Install ansible using `sudo pip install ansible`.
2424
5. Run the [`hack/ci/setup-openshift`][script] script, which spins up an openshift cluster by configuring docker and then downloading the `oc` v3.11 binary and running `oc cluster up`.
@@ -31,7 +31,7 @@ The Go, Ansible, and Helm tests then differ in what tests they run.
3131
1. Run `go vet`.
3232
2. Check that all source files have a license.
3333
3. Check that all error messages start with a lower case alphabetical character and do not end with punctuation, and log messages start with an upper case alphabetical character.
34-
4. Make sure the repo is in a clean state (this is particularly useful for making sure the `Gopkg.lock` file up to date after `dep ensure`).
34+
4. Make sure the repo is in a clean state (this is particularly useful for making sure `go.mod` and `go.sum` are up-to-date after running `make tidy`)).
3535
2. Run unit tests.
3636
1. Run `make test`.
3737
3. Run [subcommand tests][subcommand].

doc/user-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ This guide walks through an example of building a simple memcached-operator usin
55

66
## Prerequisites
77

8-
- [dep][dep_tool] version v0.5.0+.
98
- [git][git_tool]
109
- [go][go_tool] version v1.12+.
1110
- [docker][docker_tool] version 17.03+.
1211
- [kubectl][kubectl_tool] version v1.11.3+.
1312
- Access to a Kubernetes v1.11.3+ cluster.
13+
- Optional: [dep][dep_tool] version v0.5.0+.
1414

1515
**Note**: This guide uses [minikube][minikube_tool] version v0.25.0+ as the local Kubernetes cluster and [quay.io][quay_link] for the public registry.
1616

doc/user/install-operator-sdk.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,23 @@ $ brew install operator-sdk
7575
7676
## Compile and install from master
7777
78+
### Prerequisites
79+
80+
- [git][git_tool]
81+
- [mercurial][mercurial_tool] version 3.9+
82+
- [bazaar][bazaar_tool] version 2.7.0+
83+
- [go][go_tool] version v1.12+.
84+
7885
```sh
7986
$ go get -d github.com/operator-framework/operator-sdk # This will download the git repository and not install it
8087
$ cd $GOPATH/src/github.com/operator-framework/operator-sdk
8188
$ git checkout master
82-
$ make dep
89+
$ make tidy
8390
$ make install
8491
```
8592
8693
[homebrew_tool]:https://brew.sh/
94+
[git_tool]:https://git-scm.com/downloads
95+
[mercurial_tool]:https://www.mercurial-scm.org/downloads
96+
[bazaar_tool]:http://wiki.bazaar.canonical.com/Download
97+
[go_tool]:https://golang.org/dl/

0 commit comments

Comments
 (0)