From 60650ce96cdbb55aecaed6c087dd0589f1a2648e Mon Sep 17 00:00:00 2001 From: Lawrence Qiu Date: Wed, 3 Jun 2026 19:43:37 +0000 Subject: [PATCH 1/4] chore(.github): update bug report template Update the GitHub bug report issue template to use the new structured format, incorporating user feedback. TAG=agy CONV=9c03bcff-1791-47d3-b71c-8d7ce9d84db0 --- .github/ISSUE_TEMPLATE/bug_report.md | 121 ++++++++++++++++++++++----- 1 file changed, 99 insertions(+), 22 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 619bbfa9fd03..8fcb0c1cdb7b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,46 +6,123 @@ about: Create a report to help us improve Thanks for stopping by to let us know something could be better! -**PLEASE READ**: If you have a support contract with Google, please create an issue in the [support console](https://cloud.google.com/support/) instead of filing on GitHub. This will ensure a timely response. +**PLEASE READ**: If you have a support contract with Google, please create an issue in the [support console](https://cloud.google.com/support/) instead of filing on GitHub. This will ensure a timely response. We try to review github issues on a regular basis, however we cannot guarantee an SLO. -Please run down the following list and make sure you've tried the usual "quick fixes": +Before creating this issue, please run down the following list and make sure you've tried the usual "quick fixes": - Search the issues already opened: https://github.com/googleapis/google-cloud-java/issues - Check for answers on StackOverflow: http://stackoverflow.com/questions/tagged/google-cloud-platform -If you are still having issues, please include as much information as possible: +To help expedite the resolution of the issue, please fill out as much information as possible. If unable to provide information, please note down why the information is unable to be provided. -#### Environment details +## Issue Details -1. Specify the API at the beginning of the title. For example, "[vision]: ..."). - General, Core, and Other are also allowed as types -2. OS type and version: -3. Java version: -4. Version(s): +Required: Provide a detailed description of the issue. Any additional information helps with figuring out the issue. -#### Steps to reproduce +### Example +I am seeing {ISSUE} when running X, Y... after doing Z. This behavior started after the X library upgrade a few weeks ago ... - 1. ? - 2. ? +## Environment -#### Code example +Required: Provide details about your environment. If relevant, please also provide details about your GCP environment details. The environment details MUST be filled out. -```java -// example +Provide the relevant details about your environment: + + - OS Type and Version: + - Java Version and JDK Vendor: + - (If using GraalVM) GraalVM Version: + +If deployed on GCP, provide the relevant details about your GCP deployment environment: + + - Project ID (Optional): + - Cloud Services: + - Deployment Environment (Compute, GKE, Run, etc): + +## Dependencies + +Required: Provide a list of the dependencies that are being used. If unable to provide the list, please list the relevant libraries shown below. One of the two sections below MUST be filled out. + +1. List your application’s dependency versions. Please provide the output of `mvn dependency:tree`, `gradle dependencies`, or your build system. + +### Example `mvn dependency:tree` output ``` +maven-dependency-plugin:tree + +- com.google.cloud:{X}:{Y} + +- com.google.auth:{X}:{Y} + +... +``` + +2. Provide the versions of the relevant libraries: + - Libraries-Bom ([com.google.cloud:libraries-bom](https://central.sonatype.com/artifact/com.google.cloud/libraries-bom)): + - (If not using Libraries-Bom) Client Libraries: + - Gax (gax / gax-grpc / gax-httpjson): + - Auth (google-auth-library-oauth2-http / google-auth-library-credentials): + - Any other relevant Java SDK dependencies: + - Google-Http-Java-Client ([com.google.http-client:google-http-client](https://central.sonatype.com/artifact/com.google.http-client/google-http-client)): + - Any Java Frameworks being used: + - If using Spring Cloud GCP ([com.google.cloud:spring-cloud-gcp](https://central.sonatype.com/artifact/com.google.cloud:spring-cloud-gcp)), version of Spring Cloud GCP and associated ‘starter’ dependencies + +Are you using the latest versions of the Java SDK? If not, is it possible to upgrade to use the latest versions? + +- Recommendation is to use [Libraries-Bom](https://cloud.google.com/java/docs/bom) to manage dependencies + +## Reproducer -#### Stack trace +Required: Provide a reproducer and the steps needed to reproduce this issue locally. If unable to provide a reproducer, please provide code snippets to help reproduce the issue. One of the two sections below MUST be filled out. + +1. A reproducer is the quickest method to resolving this issue. It could be a test case or a sample application. It is easier for us to troubleshoot the problem and to verify the solution. + +Steps to reproduce: + +### Example +1. Enable Speech API +2. Upload a .mp4 file to GCS +3. ... +4. See {ERROR} + +If unable to provide a reproducer, please provide a reason: ... + +2. Provide as many code snippets as possible: + +### Example +```java +try (InstancesClient instancesClient = InstancesClient.create()) { + ... +} ``` -Any relevant stacktrace here. + +## Logs and Stack Trace + +Required: Provide logs that showcase the error. This will help show the flow of the application and help narrow down the cause. Additionally, provide a stack trace of the error if possible. + +The Java SDK has a troubleshooting [guide](https://github.com/googleapis/google-cloud-java/blob/main/TROUBLESHOOTING.md) for enabling logs. This contains information regarding client-server communication, request and response details, and logging in dependency libraries. If using this guide, please obfuscate any private information (bearer tokens, request and response params, etc). + +Additionally, please provide a stack trace of error seen: + +### Example ``` +TransportContext.java:347|Fatal (CERTIFICATE_UNKNOWN): PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target ( -#### External references such as API reference guides +"throwable" : { -- ? +sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target + + at sun.security.validator.PKIXValidator.doBuild(PKIXValidator.java:456) + + at sun.security.validator.PKIXValidator.engineValidate(PKIXValidator.java:323) + +... +``` -#### Any additional information below +## Behavior +Optional: Any additional information about the behavior of the error is helpful to debug. -Following these steps guarantees the quickest resolution possible. +Behavioral Questions: -Thanks! + - When did the issue begin? Is this behavior related to any dependency version upgrade? + - Is this behavior flaky? Or is this consistently seen in production? + - Is this behavior related to the volume of data? From d2fb6758c7dce86c7d0123198db5a17865663440 Mon Sep 17 00:00:00 2001 From: Lawrence Qiu Date: Wed, 3 Jun 2026 19:52:40 +0000 Subject: [PATCH 2/4] chore(.github): address further feedback on bug report template - Make GCP deployment environment section optional. - Remove Spring Cloud GCP framework reference. - Move SDK upgrade and BOM recommendations to quick fixes. - Add link to Google Cloud Java Getting Started guides. TAG=agy CONV=9c03bcff-1791-47d3-b71c-8d7ce9d84db0 --- .github/ISSUE_TEMPLATE/bug_report.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 8fcb0c1cdb7b..9887f4f7b55b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -12,6 +12,8 @@ Before creating this issue, please run down the following list and make sure you - Search the issues already opened: https://github.com/googleapis/google-cloud-java/issues - Check for answers on StackOverflow: http://stackoverflow.com/questions/tagged/google-cloud-platform + - Refer to the [Google Cloud Java Getting Started guides](https://docs.cloud.google.com/java/getting-started) for common usage patterns and troubleshooting. + - Verify you are using the latest versions of the Java SDK. If not, is it possible to upgrade? We recommend using the [Libraries-Bom](https://cloud.google.com/java/docs/bom) to manage dependency versions. To help expedite the resolution of the issue, please fill out as much information as possible. If unable to provide information, please note down why the information is unable to be provided. @@ -32,9 +34,9 @@ Provide the relevant details about your environment: - Java Version and JDK Vendor: - (If using GraalVM) GraalVM Version: -If deployed on GCP, provide the relevant details about your GCP deployment environment: +If deployed on GCP, provide the relevant details about your GCP deployment environment (Optional): - - Project ID (Optional): + - Project ID: - Cloud Services: - Deployment Environment (Compute, GKE, Run, etc): @@ -63,11 +65,6 @@ maven-dependency-plugin:tree - Any other relevant Java SDK dependencies: - Google-Http-Java-Client ([com.google.http-client:google-http-client](https://central.sonatype.com/artifact/com.google.http-client/google-http-client)): - Any Java Frameworks being used: - - If using Spring Cloud GCP ([com.google.cloud:spring-cloud-gcp](https://central.sonatype.com/artifact/com.google.cloud:spring-cloud-gcp)), version of Spring Cloud GCP and associated ‘starter’ dependencies - -Are you using the latest versions of the Java SDK? If not, is it possible to upgrade to use the latest versions? - -- Recommendation is to use [Libraries-Bom](https://cloud.google.com/java/docs/bom) to manage dependencies ## Reproducer From 52a297b8ef75c7d734629099e027b09b6ec396b6 Mon Sep 17 00:00:00 2001 From: Lawrence Qiu Date: Wed, 3 Jun 2026 21:20:02 +0000 Subject: [PATCH 3/4] chore(.github): address further feedback on bug report template (round 3) - Move (Optional) marker to the front of the GCP environment section. - Remove "Any Java Frameworks being used" section. TAG=agy CONV=9c03bcff-1791-47d3-b71c-8d7ce9d84db0 --- .github/ISSUE_TEMPLATE/bug_report.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 9887f4f7b55b..808fc2656c7e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -34,7 +34,7 @@ Provide the relevant details about your environment: - Java Version and JDK Vendor: - (If using GraalVM) GraalVM Version: -If deployed on GCP, provide the relevant details about your GCP deployment environment (Optional): +(Optional) If deployed on GCP, provide the relevant details about your GCP deployment environment: - Project ID: - Cloud Services: @@ -64,7 +64,6 @@ maven-dependency-plugin:tree - Auth (google-auth-library-oauth2-http / google-auth-library-credentials): - Any other relevant Java SDK dependencies: - Google-Http-Java-Client ([com.google.http-client:google-http-client](https://central.sonatype.com/artifact/com.google.http-client/google-http-client)): - - Any Java Frameworks being used: ## Reproducer From f3991011c93f9c244db9c9b243b90fc3d9c42a77 Mon Sep 17 00:00:00 2001 From: Lawrence Qiu Date: Wed, 3 Jun 2026 18:02:23 -0400 Subject: [PATCH 4/4] chore: Apply suggestions from code review Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 808fc2656c7e..458bedf666a5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,7 +6,7 @@ about: Create a report to help us improve Thanks for stopping by to let us know something could be better! -**PLEASE READ**: If you have a support contract with Google, please create an issue in the [support console](https://cloud.google.com/support/) instead of filing on GitHub. This will ensure a timely response. We try to review github issues on a regular basis, however we cannot guarantee an SLO. +**PLEASE READ**: If you have a support contract with Google, please create an issue in the [support console](https://cloud.google.com/support/) instead of filing on GitHub. This will ensure a timely response. We try to review GitHub issues on a regular basis, however we cannot guarantee an SLO. Before creating this issue, please run down the following list and make sure you've tried the usual "quick fixes": @@ -26,7 +26,7 @@ I am seeing {ISSUE} when running X, Y... after doing Z. This behavior started af ## Environment -Required: Provide details about your environment. If relevant, please also provide details about your GCP environment details. The environment details MUST be filled out. +Required: Provide details about your environment. If relevant, please also provide details about your GCP environment. The environment details MUST be filled out. Provide the relevant details about your environment: @@ -69,7 +69,7 @@ maven-dependency-plugin:tree Required: Provide a reproducer and the steps needed to reproduce this issue locally. If unable to provide a reproducer, please provide code snippets to help reproduce the issue. One of the two sections below MUST be filled out. -1. A reproducer is the quickest method to resolving this issue. It could be a test case or a sample application. It is easier for us to troubleshoot the problem and to verify the solution. +1. A reproducer is the quickest method to resolve this issue. It could be a test case or a sample application. It is easier for us to troubleshoot the problem and to verify the solution. Steps to reproduce: @@ -96,7 +96,7 @@ Required: Provide logs that showcase the error. This will help show the flow of The Java SDK has a troubleshooting [guide](https://github.com/googleapis/google-cloud-java/blob/main/TROUBLESHOOTING.md) for enabling logs. This contains information regarding client-server communication, request and response details, and logging in dependency libraries. If using this guide, please obfuscate any private information (bearer tokens, request and response params, etc). -Additionally, please provide a stack trace of error seen: +Additionally, please provide a stack trace of the error seen: ### Example ```