From bbf5e75e6327822c786e94efdf76c02bb2ad08f0 Mon Sep 17 00:00:00 2001 From: Helen Y <56097766+heyams@users.noreply.github.com> Date: Thu, 16 Jul 2020 16:58:56 -0700 Subject: [PATCH] Minor update to the contributing doc (#707) * Minor update to the contributing doc * Update CONTRIBUTING.md Set core.autocrlf locally. Co-authored-by: Trask Stalnaker * Update CONTRIBUTING.md Add more clarity. Co-authored-by: Trask Stalnaker * Use .gitattributes to make spotless respect line endings Co-authored-by: Trask Stalnaker --- .gitattributes | 5 +++++ CONTRIBUTING.md | 19 ++++++++++++++++--- 2 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 .gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000000..ca25a2ac3a --- /dev/null +++ b/.gitattributes @@ -0,0 +1,5 @@ +* text=auto eol=lf + +*.bat text eol=crlf +*.cmd text eol=crlf + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6e8d7c9ead..289e69e59e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,7 +65,7 @@ still access helper classes from bootstrap classloader. #### Agent jar structure If you now look inside -`java-agent/build/libs/opentelemetry-javaagent--all.jar`, you will see the +`opentelemetry-javaagent/build/libs/opentelemetry-javaagent--all.jar`, you will see the following "clusters" of classes: - `inst/` - contains `agent-tooling` module and `instrumentation` submodules, loaded and isolated inside @@ -86,10 +86,23 @@ snapshot builds of the `master` branch. They are available from Build using Java 11: -```gradle assemble``` +```bash +java -version +``` + +```bash +./gradlew assemble +``` + +and then generate the -all artifact + +```bash +./gradlew :opentelemetry-javaagent:shadowJar +``` and then you can find the java agent artifact at -`java-agent/build/lib/opentelemetry-javaagent--all.jar`. + +`opentelemetry-javaagent/build/lib/opentelemetry-javaagent--all.jar`. ### Testing