Skip to content

Commit e801d02

Browse files
committed
fixup: Update README to mention the need to vendor tmpnet
1 parent 2b47e79 commit e801d02

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

tests/fixture/tmpnet/README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -411,9 +411,9 @@ Example usage:
411411
loki_password: ${{ secrets.LOKI_PASSWORD || '' }}
412412
```
413413
414-
The action assumes a nix flake file in the repo root that enables
414+
The action requires a flake.nix file in the repo root that enables
415415
availability of promtail and prometheus. The following is a minimal
416-
flake file that inherits from the avalanchego flake:
416+
flake that inherits from the avalanchego flake:
417417
418418
```nix
419419
{
@@ -442,6 +442,18 @@ flake file that inherits from the avalanchego flake:
442442
}
443443
```
444444

445+
The action also requires being able to invoke tmpnetctl via `go
446+
run`. Use of a `tools.go` file that imports tmpnetctl is suggested to
447+
enable this:
448+
449+
```golang
450+
package tools
451+
452+
import (
453+
_ "github.com/ava-labs/avalanchego/tests/fixture/tmpnet/cmd" // tmpnetctl
454+
)
455+
```
456+
445457
### Viewing
446458

447459
#### Local networks

0 commit comments

Comments
 (0)