Skip to content

Commit

Permalink
doc/dev: removing references to dep for building and testing the SDK …
Browse files Browse the repository at this point in the history
…repo
  • Loading branch information
joelanford committed Jun 17, 2019
1 parent 75a1d5c commit 5c765b2
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 12 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ The following workflow is for a new **Helm** operator:

## Prerequisites

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

## Quick Start

Expand Down
2 changes: 0 additions & 2 deletions doc/dev/developer_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
This document explains how to setup your dev environment.

## Prerequisites
- [dep][dep_tool] version v0.5.0+
- [git][git_tool]
- [go][go_tool] version v1.12+

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

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

[dep_tool]:https://golang.github.io/dep/docs/installation.html
[git_tool]:https://git-scm.com/downloads
[go_tool]:https://golang.org/dl/
[repo_sdk]:https://github.com/operator-framework/operator-sdk
Expand Down
10 changes: 6 additions & 4 deletions doc/dev/testing/running-the-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,16 +77,18 @@ $ eval $(minikube docker-env)

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

- `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.
- `test/ci-go` - Runs all the tests that the Go job runs in CI (`sanity`, `unit`, `subcommand`, `e2e/go`).
- `test/ci-ansible` - Runs all the tests that the Ansible job runs in CI (`e2e/ansible`).
- `test` - Runs the unit tests.
- `test-ci` - Runs markdown, sanity, and unit tests, installs the SDK binary, and runs the SDK subcommand and all E2E tests.
- `test/ci-go` - Runs all the tests that the Go job runs in CI (`subcommand` and `e2e/go`).
- `test/ci-ansible` - Runs all the tests that the Ansible job runs in CI (`e2e/ansible` and `e2e/ansible-molecule`).
- `test/ci-helm` - Runs all the tests that the Helm job runs in CI (`e2e/helm`).
- `test/sanity` - Runs sanity checks.
- `test/unit` - Runs unit tests.
- `test/subcommand` - Runs subcommand tests.
- `test/e2e` - Runs all E2E tests (`e2e/go`, `e2e/ansible`, and `e2e/helm`).
- `test/e2e` - Runs all E2E tests (`e2e/go`, `e2e/ansible`, `e2e/ansible-molecule`, and `e2e/helm`).
- `test/e2e/go` - Runs the go E2E test.
- `test/e2e/ansible` - Runs the ansible E2E test.
- `test/e2e/ansible-molecule` - Runs the ansible molecule tests.
- `test/e2e/helm` - Runs the helm E2E test.
- `test/markdown` - Runs the markdown checks

Expand Down
4 changes: 2 additions & 2 deletions doc/dev/testing/travis-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For the Go, Ansible, and Helm tests, the `before_install` and `install` stages a

1. Check if non documentation files have been updated.
- If only documentation has been updated, skip these tests.
2. Download dep and run `dep ensure`.
2. Run `make tidy` to ensure `go.mod` and `go.sum` are up-to-date.
3. Build and install the sdk using `make install`.
4. Install ansible using `sudo pip install ansible`.
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`.
Expand All @@ -31,7 +31,7 @@ The Go, Ansible, and Helm tests then differ in what tests they run.
1. Run `go vet`.
2. Check that all source files have a license.
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.
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`).
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`)).
2. Run unit tests.
1. Run `make test`.
3. Run [subcommand tests][subcommand].
Expand Down
2 changes: 1 addition & 1 deletion doc/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ This guide walks through an example of building a simple memcached-operator usin

## Prerequisites

- [dep][dep_tool] version v0.5.0+.
- [git][git_tool]
- [go][go_tool] version v1.12+.
- [docker][docker_tool] version 17.03+.
- [kubectl][kubectl_tool] version v1.11.3+.
- Access to a Kubernetes v1.11.3+ cluster.
- Optional: [dep][dep_tool] version v0.5.0+.

**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.

Expand Down
13 changes: 12 additions & 1 deletion doc/user/install-operator-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,23 @@ $ brew install operator-sdk
## Compile and install from master
### Prerequisites
- [git][git_tool]
- [mercurial][mercurial_tool] version 3.9+
- [bazaar][bazaar_tool] version 2.7.0+
- [go][go_tool] version v1.12+.
```sh
$ go get -d github.com/operator-framework/operator-sdk # This will download the git repository and not install it
$ cd $GOPATH/src/github.com/operator-framework/operator-sdk
$ git checkout master
$ make dep
$ make tidy
$ make install
```
[homebrew_tool]:https://brew.sh/
[git_tool]:https://git-scm.com/downloads
[mercurial_tool]:https://www.mercurial-scm.org/downloads
[bazaar_tool]:http://wiki.bazaar.canonical.com/Download
[go_tool]:https://golang.org/dl/

0 comments on commit 5c765b2

Please sign in to comment.