Skip to content

Update japicmp baseline docs to match pinned apidiffBaselineVersion #8616

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

Open
thswlsqls wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −3
Open

Update japicmp baseline docs to match pinned apidiffBaselineVersion #8616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions docs/knowledge/api-design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/<artifact>.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/<artifact>.txt`.

- Breaking changes in stable modules fail the build.
- AutoValue classes are exempt from the abstract-method-added check — the generated implementation
Expand Down
2 changes: 1 addition & 1 deletion docs/knowledge/gradle-conventions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading