Skip to content

Commit

Permalink
Update index.md with instructions on how to upgrade Ginkgo
Browse files Browse the repository at this point in the history
fixes #1129
  • Loading branch information
onsi committed Feb 1, 2023
1 parent 64c4110 commit 833a75e
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/ginkgo@v2.m.p
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

Expand Down

0 comments on commit 833a75e

Please sign in to comment.