Skip to content

Commit 7be9661

Browse files
authored
Update contributing docs (#4505)
1 parent fee85fa commit 7be9661

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,31 @@ and then you can find the java agent artifact at
2626

2727
`agent/agent/build/libs/applicationinsights-agent-<version>.jar`.
2828

29+
## Updating dependencies
30+
31+
When updating dependencies in the project, you need to regenerate the dependency lock files
32+
and license reports.
33+
34+
### Regenerate lock files
35+
36+
After updating dependencies in any `build.gradle.kts` file, regenerate the lock files:
37+
38+
```bash
39+
./gradlew resolveAndLockAll --write-locks
40+
```
41+
42+
This will update all `gradle.lockfile` files throughout the project to reflect the new dependency versions.
43+
44+
### Regenerate license files
45+
46+
After updating dependencies, regenerate the license report to include licenses for new dependencies:
47+
48+
```bash
49+
./gradlew generateLicenseReport --no-build-cache
50+
```
51+
52+
This ensures all third-party licenses are properly documented.
53+
2954
## IntelliJ setup and troubleshooting
3055

3156
See [IntelliJ setup and troubleshooting](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/contributing/intellij-setup-and-troubleshooting.md)

0 commit comments

Comments
 (0)