summaryrefslogtreecommitdiff
path: root/vendor/github.com/onsi/ginkgo/README.md
diff options
context:
space:
mode:
authordependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>2020-06-15 10:21:06 +0000
committerDaniel J Walsh <dwalsh@redhat.com>2020-06-15 08:35:25 -0400
commit68eca3c19e010882f7c82b70437f4edbbbfeca3d (patch)
tree174f45a2fb583fa07a183083ff180c406ca74fc0 /vendor/github.com/onsi/ginkgo/README.md
parentc2690c24530d202c5fef07bc8ef7b3d3c5ad747c (diff)
downloadpodman-68eca3c19e010882f7c82b70437f4edbbbfeca3d.tar.gz
podman-68eca3c19e010882f7c82b70437f4edbbbfeca3d.tar.bz2
podman-68eca3c19e010882f7c82b70437f4edbbbfeca3d.zip
Bump github.com/onsi/ginkgo from 1.12.3 to 1.13.0
Bumps [github.com/onsi/ginkgo](https://github.com/onsi/ginkgo) from 1.12.3 to 1.13.0. - [Release notes](https://github.com/onsi/ginkgo/releases) - [Changelog](https://github.com/onsi/ginkgo/blob/master/CHANGELOG.md) - [Commits](https://github.com/onsi/ginkgo/compare/v1.12.3...v1.13.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Diffstat (limited to 'vendor/github.com/onsi/ginkgo/README.md')
-rw-r--r--vendor/github.com/onsi/ginkgo/README.md29
1 files changed, 25 insertions, 4 deletions
diff --git a/vendor/github.com/onsi/ginkgo/README.md b/vendor/github.com/onsi/ginkgo/README.md
index ddb0cd882..fab114580 100644
--- a/vendor/github.com/onsi/ginkgo/README.md
+++ b/vendor/github.com/onsi/ginkgo/README.md
@@ -75,15 +75,36 @@ Ginkgo is best paired with Gomega. Learn more about Gomega [here](https://onsi.
Agouti allows you run WebDriver integration tests. Learn more about Agouti [here](https://agouti.org)
-## Set Me Up!
+## Getting Started
-You'll need the Go command-line tools. Ginkgo is tested with Go 1.6+, but preferably you should get the latest. Follow the [installation instructions](https://golang.org/doc/install) if you don't have it installed.
+You'll need the Go command-line tools. Follow the [installation instructions](https://golang.org/doc/install) if you don't have it installed.
+### Global installation
+To install the Ginkgo command line interface into the `$PATH` (actually to `$GOBIN`):
```bash
+go get -u github.com/onsi/ginkgo/ginkgo
+```
+
+### Go module ["tools package"](https://github.com/golang/go/issues/25922):
+Create (or update) a file called `tools/tools.go` with the following contents:
+```go
+// +build tools
+
+package tools
-go get -u github.com/onsi/ginkgo/ginkgo # installs the ginkgo CLI
-go get -u github.com/onsi/gomega/... # fetches the matcher library
+import (
+ _ "github.com/onsi/ginkgo"
+)
+// This file imports packages that are used when running go generate, or used
+// during the development process but not otherwise depended on by built code.
+```
+The Ginkgo command can then be run via `go run github.com/onsi/ginkgo/ginkgo`.
+This approach allows the version of Ginkgo to be maintained under source control for reproducible results,
+and is well suited to automated test pipelines.
+
+### Bootstrapping
+```bash
cd path/to/package/you/want/to/test
ginkgo bootstrap # set up a new ginkgo suite