chore: add readme for google-cloud-bigquery-jdbc
#4071
Conversation
product-auto-label
bot
added
size: l
Summary of ChangesHello @keshavdandeva, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a new Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces the README.md file for the google-cloud-bigquery-jdbc project. The README covers essential aspects such as quickstart instructions, authentication, authorization, a developer guide, packaging details, and supported Java versions. While the content is comprehensive, there are several areas that require attention to improve accuracy, clarity, and maintainability. These include version inconsistencies in dependency declarations, several typos, an incorrect example command for integration tests, and the presence of internal Google URLs that should not be in a public-facing document. Addressing these points will significantly enhance the quality and usefulness of the documentation.
|
|
||
| Nightly Integration Tests include a step to build a full and thin jars and upload them to [Google Storage](https://pantheon.corp.google.com/storage/browser/bq_devtools_release_private/drivers/jdbc;tab=objects?inv=1&invt=Ab4E6g&project=bigquery-devtools-drivers&prefix=&forceOnObjectsSortingFiltering=false). |
There was a problem hiding this comment.
This URL points to an internal Google Storage location (pantheon.corp.google.com). This should not be present in a public README. Please remove this link and the associated descriptive text, or replace it with a public-facing alternative if one exists.
| Nightly Integration Tests include a step to build a full and thin jars and upload them to [Google Storage](https://pantheon.corp.google.com/storage/browser/bq_devtools_release_private/drivers/jdbc;tab=objects?inv=1&invt=Ab4E6g&project=bigquery-devtools-drivers&prefix=&forceOnObjectsSortingFiltering=false). | |
| Nightly Integration Tests include a step to build a full and thin jars and upload them to Google Storage. |
| [Cloud Build Pipeline](https://pantheon.corp.google.com/cloud-build/triggers;region=us-east1/edit/125214da-8603-449d-8336-b6dba7196bb4?project=bigquery-devtools-drivers) | ||
| is uploading latest full jar to the internal location for perf tests once a week, at the moment scheduled to do this Sunday night. |
There was a problem hiding this comment.
This URL points to an internal Cloud Build Pipeline (pantheon.corp.google.com). This should not be present in a public README. Please remove this link and the associated descriptive text, or replace it with a public-facing alternative if one exists.
| [Cloud Build Pipeline](https://pantheon.corp.google.com/cloud-build/triggers;region=us-east1/edit/125214da-8603-449d-8336-b6dba7196bb4?project=bigquery-devtools-drivers) | |
| is uploading latest full jar to the internal location for perf tests once a week, at the moment scheduled to do this Sunday night. | |
| Performance tests are uploading latest full jar to the internal location for perf tests once a week, at the moment scheduled to do this Sunday night. |
| If you are using Gradle without BOM, add this to your dependencies: | ||
|
|
||
| ```Groovy | ||
| implementation 'com.google.cloud:google-cloud-bigquery-jdbc:0.1.0' |
There was a problem hiding this comment.
Similar to the Maven dependency, the Gradle dependency version (0.1.0) should align with the pom.xml's 0.1.0-SNAPSHOT or the intended release version.
| implementation 'com.google.cloud:google-cloud-bigquery-jdbc:0.1.0' | |
| implementation 'com.google.cloud:google-cloud-bigquery-jdbc:0.1.0-SNAPSHOT' |
| If you are using SBT, add this to your dependencies: | ||
|
|
||
| ```Scala | ||
| libraryDependencies += "com.google.cloud" % "google-cloud-bigquery-jdbc" % "0.1.0" |
There was a problem hiding this comment.
The SBT dependency version (0.1.0) should also be consistent with the pom.xml's 0.1.0-SNAPSHOT or the intended release version.
| libraryDependencies += "com.google.cloud" % "google-cloud-bigquery-jdbc" % "0.1.0" | |
| libraryDependencies += "com.google.cloud" % "google-cloud-bigquery-jdbc" % "0.1.0-SNAPSHOT" |
| <dependency> | ||
| <groupId>com.google.cloud</groupId> | ||
| <artifactId>google-cloud-bigquery-jdbc</artifactId> | ||
| <version>0.1.0</version> |
There was a problem hiding this comment.
The version specified here (0.1.0) is inconsistent with the pom.xml which shows 0.1.0-SNAPSHOT. Please ensure the version in the README accurately reflects the current or intended release version. If this is a development version, 0.1.0-SNAPSHOT should be used for consistency.
| <version>0.1.0</version> | |
| <version>0.1.0-SNAPSHOT</version> |
| make docker-integration-test | ||
| ``` | ||
|
|
||
| Please note that running unit of integration tests within docker doesn't leverage maven cache because it is not persisted. |
There was a problem hiding this comment.
The phrasing "unit of integration tests" is a bit awkward. Consider changing it to "unit or integration tests" for better readability.
| Please note that running unit of integration tests within docker doesn't leverage maven cache because it is not persisted. | |
| Please note that running unit or integration tests within docker doesn't leverage maven cache because it is not persisted. |
|
|
||
| `make integration-test` | ||
|
|
||
| Run specific unitintegration test |
There was a problem hiding this comment.
There is a typo here; 'unitintegration' should be 'integration'.
| Run specific unitintegration test | |
| Run specific integration test |
| [kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-bigquery-jdbc/java7.svg | ||
| [kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-bigquery-jdbc/java7.html |
There was a problem hiding this comment.
These link definitions for kokoro-badge-image-1 and kokoro-badge-link-1 are not used anywhere in the document. Please remove unused link definitions to keep the README clean and maintainable.
| [libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM | ||
| [shell_img]: https://gstatic.com/cloudssh/images/open-btn.png |
There was a problem hiding this comment.
These link definitions for libraries-bom and shell_img are not used in this README. Please remove unused link definitions to keep the README clean and maintainable.
| [cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained | ||
| [apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries | ||
| [oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html | ||
| [g-c-j]: http://github.com/googleapis/google-cloud-java No newline at end of file |
There was a problem hiding this comment.
The link definition for g-c-j is not used in this README. Please remove unused link definitions to keep the README clean and maintainable.
1 participant
b/474642014
Add
README.mdfor google-cloud-bigquery-jdbc