From b9bdd67a7365762f2f45c25fb411a55b32437a1b Mon Sep 17 00:00:00 2001 From: Tomasz Pietrek Date: Thu, 27 Oct 2022 14:01:13 +0200 Subject: [PATCH 1/2] Add note how to avoid compatibility issues between repos It's pretty common to get into different errors while tidying or building `dapr/dapr` with local `dapr/components-contrib`. Usually checking out the latest released version helps. Signed-off-by: Tomasz Pietrek --- docs/developing-component.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/developing-component.md b/docs/developing-component.md index 4703e1dd4..564fd572d 100644 --- a/docs/developing-component.md +++ b/docs/developing-component.md @@ -55,7 +55,8 @@ make lint ## Validating with Dapr core 1. Make sure you clone the `dapr/dapr` and `dapr/components-contrib` repositories side-by-side, within the same folder. -1. Replace `github.com/dapr/components-contrib` with a reference to the locally-cloned `components-contrib`: +1. In case of compatibility issues between `dapr/dapr` and `dapr/compoments-contrib` `go.mod` files during build, checkout the latest released version of `dapr/dapr`. +4. Replace `github.com/dapr/components-contrib` with a reference to the locally-cloned `components-contrib`: ```bash go mod edit -replace github.com/dapr/components-contrib=../components-contrib ``` From 050591eed93e9d013f86bd3f744af9f813f581a5 Mon Sep 17 00:00:00 2001 From: Tomasz Pietrek Date: Thu, 27 Oct 2022 14:04:13 +0200 Subject: [PATCH 2/2] Fix ordering in docs Signed-off-by: Tomasz Pietrek --- docs/developing-component.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developing-component.md b/docs/developing-component.md index 564fd572d..256044747 100644 --- a/docs/developing-component.md +++ b/docs/developing-component.md @@ -56,7 +56,7 @@ make lint 1. Make sure you clone the `dapr/dapr` and `dapr/components-contrib` repositories side-by-side, within the same folder. 1. In case of compatibility issues between `dapr/dapr` and `dapr/compoments-contrib` `go.mod` files during build, checkout the latest released version of `dapr/dapr`. -4. Replace `github.com/dapr/components-contrib` with a reference to the locally-cloned `components-contrib`: +1. Replace `github.com/dapr/components-contrib` with a reference to the locally-cloned `components-contrib`: ```bash go mod edit -replace github.com/dapr/components-contrib=../components-contrib ```