Skip to content

Commit 1057e4e

Browse files
committed
update docs
1 parent a663089 commit 1057e4e

File tree

3 files changed

+14
-6
lines changed

3 files changed

+14
-6
lines changed

book/src/SUMMARY.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
- [NodeSet with Capabilities](./framework/nodeset_capabilities.md)
1111
- [NodeSet (Local Docker builds)](./framework/nodeset_docker_rebuild.md)
1212
- [NodeSet Compat Environment](./framework/nodeset_compatibility.md)
13+
- [Creating your own components](./developing/developing_components.md)
1314
- [Fork Testing](./framework/fork.md)
1415
- [Quick Contracts Deployment](./framework/quick_deployment.md)
1516
- [NodeSet with External Blockchain]()
@@ -82,8 +83,6 @@
8283

8384
---
8485

85-
- [Developing](developing.md)
86-
- [Components](developing/developing_components.md)
8786
- [Releasing modules](releasing_modules.md)
8887

8988
---

book/src/developing/developing_components.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,13 @@ Each component can define inputs and outputs, following these rules:
4747
- If your component is used for side effects output can be omitted.
4848
- `input.Out.UseCache` should be added if you'd like to use caching, see more [here](caching)
4949

50-
### Docker components good practices for [testcontainers-go](https://golang.testcontainers.org/):
50+
### Building Local Images
5151

52-
An example [simple component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/blockchain/anvil.go)
52+
Use `framework.BuildImage` or `framework.BuildImageOnce` to build the docker image.
5353

54-
An example of [complex component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/clnode/clnode.go)
54+
Do not use `testcontainers.NewDockerProvider()` methods, see issues: [#1](https://github.com/testcontainers/testcontainers-go/pull/2482), [#2](https://github.com/testcontainers/testcontainers-go/issues/1484)
5555

56-
An example of [composite component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/simple_node_set/node_set.go)
56+
### Docker components good practices for [testcontainers-go](https://golang.testcontainers.org/):
5757

5858
- Inputs should include at least `image`, `tag` and `pull_image` field
5959
```golang
@@ -94,3 +94,10 @@ An example of [composite component](https://github.com/smartcontractkit/chainlin
9494
HostURL: fmt.Sprintf("http://%s:%s", host, mp.Port()),
9595
}, nil
9696
```
97+
98+
An example [simple component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/blockchain/anvil.go)
99+
100+
An example of [complex component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/clnode/clnode.go)
101+
102+
An example of [composite component](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/simple_node_set/node_set.go)
103+

book/src/framework/nodeset_docker_rebuild.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,7 @@ Create a configuration file `smoke.toml`
2525

2626
These paths will work for `e2e/capabilities` in our main [repository](https://github.com/smartcontractkit/chainlink/tree/ctf-v2-tests/e2e/capabilities)
2727

28+
Also check how you can add rebuild to your [components](../developing/developing_components.md#building-local-images).
29+
2830
Summary:
2931
- We learned how we can quickly re-build local docker image for CL node

0 commit comments

Comments
 (0)