Skip to content

Commit

Permalink
Minor update to the contributing doc (#707)
Browse files Browse the repository at this point in the history
* Minor update to the contributing doc

* Update CONTRIBUTING.md

Set core.autocrlf locally.

Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>

* Update CONTRIBUTING.md

Add more clarity.

Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>

* Use .gitattributes to make spotless respect line endings

Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
  • Loading branch information
heyams and trask authored Jul 16, 2020
1 parent 9f1ffbe commit bbf5e75
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
5 changes: 5 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
* text=auto eol=lf

*.bat text eol=crlf
*.cmd text eol=crlf

19 changes: 16 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-<version>-all.jar`, you will see the
`opentelemetry-javaagent/build/libs/opentelemetry-javaagent-<version>-all.jar`, you will see the
following "clusters" of classes:

- `inst/` - contains `agent-tooling` module and `instrumentation` submodules, loaded and isolated inside
Expand All @@ -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-<version>-all.jar`.

`opentelemetry-javaagent/build/lib/opentelemetry-javaagent-<version>-all.jar`.

### Testing

Expand Down

0 comments on commit bbf5e75

Please sign in to comment.