diff --git a/docs/knowledge/api-design.md b/docs/knowledge/api-design.md index 00c9a817fc1..9b26f27d01f 100644 --- a/docs/knowledge/api-design.md +++ b/docs/knowledge/api-design.md @@ -86,8 +86,9 @@ Rules: ## japicmp `otel.japicmp-conventions` runs the `jApiCmp` task as part of `check` for every published module. -It compares the locally-built jar against the latest release to detect breaking changes, and writes -a human-readable diff to `docs/apidiffs/current_vs_latest/.txt`. +It compares the locally-built jar against the release pinned by `apidiffBaselineVersion` in +`version.gradle.kts` to detect breaking changes, and writes a human-readable diff to +`docs/apidiffs/current_vs_latest/.txt`. - Breaking changes in stable modules fail the build. - AutoValue classes are exempt from the abstract-method-added check — the generated implementation diff --git a/docs/knowledge/gradle-conventions.md b/docs/knowledge/gradle-conventions.md index cb0a86d19ec..394eb54b1b7 100644 --- a/docs/knowledge/gradle-conventions.md +++ b/docs/knowledge/gradle-conventions.md @@ -23,7 +23,7 @@ Every module applies a base set of convention plugins from `buildSrc/src/main/ko | `otel.publish-conventions` | Maven publishing, POM generation | Published (non-internal) modules | | `otel.animalsniffer-conventions` | Android API level compatibility checking | Modules targeting Android | | `otel.jmh-conventions` | JMH benchmark support | Modules with benchmarks | -| `otel.japicmp-conventions` | API diff generation against latest release | Published modules (applied by `otel.publish-conventions`) | +| `otel.japicmp-conventions` | API diff generation against the pinned `apidiffBaselineVersion` release | Published modules (applied by `otel.publish-conventions`) | | `otel.protobuf-conventions` | Protobuf code generation | Protobuf modules only | A typical published module: