-
-
Notifications
You must be signed in to change notification settings - Fork 665
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update index.md with instructions on how to upgrade Ginkgo
fixes #1129
- Loading branch information
Showing
1 changed file
with
19 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -46,7 +46,25 @@ This fetches Ginkgo and installs the `ginkgo` executable under `$GOBIN` - you'll | |
|
||
You should now be able to run `ginkgo version` at the command line and see the Ginkgo CLI emit a version number. | ||
|
||
**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. | ||
**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. | ||
|
||
#### Upgrading Ginkgo | ||
|
||
To upgrade Ginkgo run: | ||
|
||
```bash | ||
go get github.com/onsi/ginkgo/v2/ginkgo | ||
go install github.com/onsi/ginkgo/v2/ginkgo | ||
``` | ||
|
||
To pick a particular version: | ||
|
||
```bash | ||
go get github.com/onsi/ginkgo/v2/[email protected] | ||
go install github.com/onsi/ginkgo/v2/ginkgo | ||
``` | ||
|
||
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. | ||
|
||
### Support Policy | ||
|
||
|