Skip to content

Commit 2691dd8

Browse files
committedOct 12, 2022
further emphasize that a version match is required when running Ginkgo on CI and/or locally
1 parent 822a937 commit 2691dd8

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed
 

‎docs/index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ This fetches Ginkgo and installs the `ginkgo` executable under `$GOBIN` - you'll
4646

4747
You should now be able to run `ginkgo version` at the command line and see the Ginkgo CLI emit a version number.
4848

49+
**Note** you _must_ make sure the version of the `ginkgo` cli you install is the same as the version of Ginkgo in your `go.mod` file.
50+
4951
### Your First Ginkgo Suite
5052

5153
Ginkgo hooks into Go's existing `testing` infrastructure. That means that Ginkgo specs live in `*_test.go` files, just like standard go tests. However, instead of using `func TestX(t *testing.T) {}` to write your tests you use the Ginkgo and Gomega DSLs.
@@ -3347,7 +3349,7 @@ In this chapter we'll switch gears and illustrate common patterns for how Ginkgo
33473349

33483350
### Recommended Continuous Integration Configuration
33493351

3350-
When running in CI you'll want to make sure that the version of the `ginkgo` CLI you are using matches the version of Ginkgo in your `go.mod` file. You can ensure this by invoking the `ginkgo` command via `go run`:
3352+
When running in CI you must make sure that the version of the `ginkgo` CLI you are using matches the version of Ginkgo in your `go.mod` file. You can ensure this by invoking the `ginkgo` command via `go run`:
33513353

33523354
`go run github.com/onsi/ginkgo/v2/ginkgo`
33533355

0 commit comments

Comments
 (0)
Please sign in to comment.