Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add dev mode where warnings don't fail the test #11273

Merged
merged 6 commits into from
Jun 12, 2024
Merged

add dev mode where warnings don't fail the test #11273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3ab01dd
add dev mode where warnings don't fail the test
zeitlinger May 2, 2024
968dab2
use local build cache in dev mode
zeitlinger May 14, 2024
23272a7
document dev mode
zeitlinger May 28, 2024
d8902fe
Update docs/contributing/running-tests.md
zeitlinger Jun 12, 2024
1a4500a
Update docs/contributing/running-tests.md
zeitlinger Jun 12, 2024
81fc9fc
remove local build cache
zeitlinger Jun 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions conventions/src/main/kotlin/otel.java-conventions.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,13 @@ tasks.withType<JavaCompile>().configureEach {
// We suppress the "options" warning because it prevents compilation on modern JDKs
"-Xlint:-options",
// jdk21 generates more serial warnings than previous versions
"-Xlint:-serial",

// Fail build on any warning
"-Werror"
"-Xlint:-serial"
)
)
if (System.getProperty("dev") != "true") {
// Fail build on any warning
compilerArgs.add("-Werror")
}
}

encoding = "UTF-8"
Expand Down
12 changes: 12 additions & 0 deletions docs/contributing/running-tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,18 @@ To run these tests locally, add `-PtestLatestDeps=true` to your existing `gradle

Executing `./gradlew :instrumentation:<INSTRUMENTATION_NAME>:test --tests <GROOVY TEST FILE NAME>` will run only the selected test.

### How to prevent linting and formatting warnings from failing tests

During local development, you may want to ignore lint warnings when running tests.

To ignore warnings, formatting issues, or other non-fatal issues in tests, use

```
./gradlew test -Ddev=true -x spotlessCheck -x checkstyleMain
```

The `dev` flag will ignore warnings in tests.

## Smoke tests

The smoke tests are not run as part of a global `test` task run since they take a long time and are
Expand Down
Loading