Skip to content

Commit 833a75e

Browse files
authored
Update index.md with instructions on how to upgrade Ginkgo
fixes #1129
1 parent 64c4110 commit 833a75e

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

docs/index.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,25 @@ 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.
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. You can do this by running `go install github.com/onsi/ginkgo/v2/ginkgo` from your package.
50+
51+
#### Upgrading Ginkgo
52+
53+
To upgrade Ginkgo run:
54+
55+
```bash
56+
go get github.com/onsi/ginkgo/v2/ginkgo
57+
go install github.com/onsi/ginkgo/v2/ginkgo
58+
```
59+
60+
To pick a particular version:
61+
62+
```bash
63+
go get github.com/onsi/ginkgo/v2/[email protected]
64+
go install github.com/onsi/ginkgo/v2/ginkgo
65+
```
66+
67+
Note that in both cases we `go get` the `/v2/ginkgo` subpackage. This pulls in the CLI and its dependencies. If you only `go get github.com/onsi/ginkgo/v2` you may experience issues installing the cli - if you do simply run `go get github.com/onsi/ginkgo/v2/ginkgo` to fetch the missing dependencies.
5068

5169
### Support Policy
5270

0 commit comments

Comments
 (0)