Skip to content

Commit 2054592

Browse files
author
Roberto Santalla
authored
Merge pull request #73 from roobre/depsync-mention
README: suggest using go-depsync to keep dependencies in sync
2 parents 00c7813 + 7d61600 commit 2054592

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

Diff for: README.md

+10
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,16 @@ Because the subcommands and flags are constrained to benefit rapid extension pro
197197
- `XK6_K6_REPO` optionally sets the path to the main k6 repository. This is useful when building with k6 forks.
198198

199199

200+
## Keeping dependencies in sync
201+
202+
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.
203+
204+
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:
205+
206+
```console
207+
/your/extension$ go-depsync --parent go.k6.io/k6
208+
```
209+
200210
---
201211

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

0 commit comments

Comments
 (0)