From c7403839c5f683be5c4b2b1e3e5ab834dbb879a2 Mon Sep 17 00:00:00 2001 From: Chris Mark Date: Mon, 18 Sep 2023 14:51:24 +0100 Subject: [PATCH] Add development note (#59) This PR adds a note on how to use the local dependency during the development process. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index c2000a1f6e..6810733c1f 100644 --- a/README.md +++ b/README.md @@ -36,3 +36,16 @@ Then the tag should be available at https://github.com/elastic/elastic-agent-aut After the tag is available a Release can be created using this tag and the proper content from the changelog. + + +## Development + +When one wants to edit and test the library as part of the Beats or Elastic Agent projects, the local version of the dependency can be referenced with the following: + +`go.mod`: +```golang +replace github.com/elastic/elastic-agent-autodiscover => /home/user/go/src/github.com/elastic/elastic-agent-autodiscover +``` + +This will use the local code rather than the upstream dependency. +Note: Do not forget to exclude this change from the final commits.