Skip to content

Commit

Permalink
Add development note (#59)
Browse files Browse the repository at this point in the history
This PR adds a note on how to use the local dependency during the
development process.
  • Loading branch information
ChrsMark authored Sep 18, 2023
1 parent 8d71966 commit c740383
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit c740383

Please sign in to comment.