{"id":14983552,"url":"https://github.com/grpc/grpc-java-api-checker","last_synced_at":"2025-10-19T11:31:29.413Z","repository":{"id":53299854,"uuid":"119746372","full_name":"grpc/grpc-java-api-checker","owner":"grpc","description":null,"archived":false,"fork":false,"pushed_at":"2023-12-07T05:06:58.000Z","size":90,"stargazers_count":30,"open_issues_count":0,"forks_count":16,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-01-29T14:23:15.626Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/grpc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-01-31T21:34:43.000Z","updated_at":"2024-05-02T23:24:19.000Z","dependencies_parsed_at":"2024-09-29T06:16:40.556Z","dependency_job_id":null,"html_url":"https://github.com/grpc/grpc-java-api-checker","commit_stats":{"total_commits":23,"total_committers":5,"mean_commits":4.6,"dds":0.4782608695652174,"last_synced_commit":"ded0486856cbd9446c1ce2324a17b0cebc51c9da"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grpc%2Fgrpc-java-api-checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grpc%2Fgrpc-java-api-checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grpc%2Fgrpc-java-api-checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grpc%2Fgrpc-java-api-checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grpc","download_url":"https://codeload.github.com/grpc/grpc-java-api-checker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237116998,"owners_count":19258343,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T14:07:25.457Z","updated_at":"2025-10-19T11:31:24.122Z","avatar_url":"https://github.com/grpc.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grpc-java-api-checker\n\n[![GitHub Actions Testing](https://github.com/grpc/grpc-java-api-checker/actions/workflows/testing.yml/badge.svg?branch=master)](https://github.com/grpc/grpc-java-api-checker/actions/workflows/testing.yml?branch=master)\n\nAn Error Prone plugin that checks for usages of grpc-java APIs that are annotated with `@ExperimentalApi` or `@Internal`.\n\n**NOTE: grpc-java-api-checker works with grpc-java version 1.10.0 or greater.**\n\nThe error examples:\n\n```\nsrc/main/java/com/example/App.java:10: error: [GrpcInternal] @Internal should not be used in application code\n    System.out.println(InternalStatus.MESSAGE_KEY);\n                       ^\n    (see https://github.com/grpc/grpc-java)\n\nsrc/main/java/com/example/App.java:11: error: [GrpcExperimentalApi] @ExperimentalApi should not be used in application code\n    System.out.println(Grpc.TRANSPORT_ATTR_REMOTE_ADDR);\n                           ^\n    (see \"https://github.com/grpc/grpc-java/issues/1710\")\n```\n\n## Usage\n\nUsing the grpc-java-api-checker requires configuring your project to build with the Error Prone Java compiler.\nYou can see the Error Prone documents [here](http://errorprone.info/).\n\n### Examples\n\n#### Maven\nThe example is [here](examples/pom.xml)\n\n``` sh\ncd examples/\nmvn compile\n```\n\n#### Gradle\nThe example is [here](examples/build.gradle)\n\n``` sh\ncd examples/\n./gradlew compileJava\n```\n\n#### Bazel\nThe example is [here](examples/BUILD.bazel)\n\n``` sh\ncd examples/\nbazel build //...\n```\n\n## Build and Test\n\n``` sh\n# Compile\nmvn compile\n\n# Test\nmvn test\n\n# Build\nmvn build\n\n# Publish to Local\nmvn install\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrpc%2Fgrpc-java-api-checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrpc%2Fgrpc-java-api-checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrpc%2Fgrpc-java-api-checker/lists"}