Skip to content

Commit

Permalink
README: suggest using go-depsync to keep dependencies in sync
Browse files Browse the repository at this point in the history
  • Loading branch information
roobre committed Nov 20, 2023
1 parent 00c7813 commit 7d61600
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,16 @@ Because the subcommands and flags are constrained to benefit rapid extension pro
- `XK6_K6_REPO` optionally sets the path to the main k6 repository. This is useful when building with k6 forks.


## Keeping dependencies in sync

We recommend extension maintainers to keep dependencies in common with k6 core in the same version k6 core uses. This guarantees binary compatibility of the JS runtime, and ensures uses will not have to face unforeseen build-time errors when compiling several extensions together with xk6.

The [`go-depsync`](https://github.com/grafana/go-depsync/) tool can check for this automatically and produce a `go get` command that syncs common dependencies:

```console
/your/extension$ go-depsync --parent go.k6.io/k6
```

---

> This project originally forked from the [xcaddy](https://github.com/caddyserver/xcaddy) project. **Thank you!**

0 comments on commit 7d61600

Please sign in to comment.