chore: README template fix in google-cloud-java#1785
Merged
Conversation
suztomo
commented
Mar 31, 2023
| [developer-console]: https://console.developers.google.com/ | ||
| [create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects | ||
| [cloud-cli]: https://cloud.google.com/cli | ||
| [troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/main/troubleshooting/readme.md#troubleshooting |
suztomo
commented
Mar 31, 2023
| If you are using Maven without the BOM, add this to your dependencies: | ||
| {% else %} | ||
| If you are using Maven, add this to your pom.xml file: | ||
| <!-- {x-version-update-start:{{ artifact_id }}:released} --> |
Member
Author
There was a problem hiding this comment.
@ddixit14 I found that this annotation should appear regardless of {% if 'snippets' in metadata and metadata['snippets'][metadata['repo']['api_shortname'] + '_install_with_bom'] -%} condition.
For example, java-storage's README.md has been missing this "x-version-update-start" annotation
ddixit14
approved these changes
Mar 31, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README.md files in the google-cloud-java monorepo to have instructions about how to use the Libraries BOM. This is part of b/274518727.
How I confirmed the change
I built the Docker image:
Checked with google-cloud-java repository
In google-cloud-java clone, I touched different Java files in java-api-gateway, java-language and java-notification.
Then I ran the code with google-cloud-java repository:
The three modules got the channge in their README files googleapis/google-cloud-java#9299. Notice the README files have Libraries BOM instruction now.
Checked with java-storage repository
The change worked as expected for java-storage module:
This actually fixes an existing bug where it wasn't adding
<!-- {x-version-update-start:google-cloud-storage:released} -->when a repository has snippet for Libraries BOM usage.