docs: explain default generation config in `README.md` by JoeWang1127 · Pull Request #3388 · googleapis/sdk-platform-java

JoeWang1127 · 2024-11-20T14:26:38Z

No description provided.

blakeli0 · 2024-11-20T16:44:21Z

hermetic_build/README.md

 ## Parameters to generate a repository using the docker image

-### Generation configuration yaml (`generation-config-path`)
+### Generation configuration yaml (`generation-config-path`), optional


Can we add a sentence before this section mentioning something like "All the parameters are optional, but a generation_config.yaml is required"?

I added this to Prerequisites.

hermetic_build/README.md

hermetic_build/library_generation/cli/entry_point.py

sonarqubecloud · 2024-11-20T17:07:39Z

Quality Gate passed for 'gapic-generator-java-root'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

sonarqubecloud · 2024-11-20T17:11:13Z

Quality Gate passed for 'java_showcase_integration_tests'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

blakeli0 · 2024-11-20T18:07:29Z

hermetic_build/README.md

+Please refer to [Generation configuration yaml](#generation-configuration-yaml--generation-config-path---optional)
+for more information.
+
+### versions.txt


IIRC, we would generate a versions.txt file if it does not exist. Can you confirm @diegomarquezp ?

No, it is not generated. The scripts will just fail if not found.

sdk-platform-java/hermetic_build/library_generation/utils/utilities.py

Lines 124 to 142 in 1080de4

def prepare_repo(

gen_config: GenerationConfig,

library_config: List[LibraryConfig],

repo_path: str,

language: str = "java",

) -> RepoConfig:

"""

Gather information of the generated repository.

:param gen_config: a GenerationConfig object representing a parsed

configuration yaml

:param library_config: a LibraryConfig object contained inside config,

passed here for convenience and to prevent all libraries to be processed

:param repo_path: the path to which the generated repository goes

:param language: programming language of the library

:return: a RepoConfig object contained repository information

:raise FileNotFoundError if there's no versions.txt in repo_path

:raise ValueError if two libraries have the same library_name

"""

I see, thanks for the quick response!

The file is required, per

sdk-platform-java/hermetic_build/library_generation/utils/utilities.py

Line 164 in 7d6d66a

raise FileNotFoundError(f"{versions_file} is not found.")

Though I think we can create an empty file if not exist since we didn't check the contents.

I'll create a follow-up issue.

🤖 I have created a release *beep* *boop* --- <details><summary>2.51.0</summary> ## [2.51.0](v2.50.0...v2.51.0) (2024-12-12) ### Features * [iam] add ResourcePolicyMember to google/iam/v1 ([b8e2859](b8e2859)) ### Bug Fixes * [#3381](#3381) ([75dcb96](75dcb96)) * graalvm missing build time class when using protobuf 4.x ([#3438](#3438)) ([f0236cf](f0236cf)) * return all library names if repo-level parameter changes ([#3379](#3379)) ([75dcb96](75dcb96)), closes [#3381](#3381) ### Dependencies * update dependency com.fasterxml.jackson:jackson-bom to v2.18.2 ([#3422](#3422)) ([fdc3a54](fdc3a54)) * update dependency com.google.api-client:google-api-client-bom to v2.7.1 ([#3450](#3450)) ([35f1310](35f1310)) * update dependency com.google.auth:google-auth-library-oauth2-http to v1.30.0 ([#3428](#3428)) ([78cbff1](78cbff1)) * update dependency com.google.errorprone:error_prone_annotations to v2.36.0 ([#3425](#3425)) ([52dcc0d](52dcc0d)) * update dependency com.google.errorprone:error_prone_annotations to v2.36.0 ([#3426](#3426)) ([77dd85d](77dd85d)) * update dependency dev.cel:cel to v0.8.0 ([#3429](#3429)) ([79cde20](79cde20)) * update dependency io.github.java-diff-utils:java-diff-utils to v4.15 ([#3430](#3430)) ([91fd5cb](91fd5cb)) * update dependency net.bytebuddy:byte-buddy to v1.15.10 ([#3298](#3298)) ([7b503de](7b503de)) * update dependency org.checkerframework:checker-qual to v3.48.3 ([#3278](#3278)) ([c5fd1b4](c5fd1b4)) * update dependency org.easymock:easymock to v5.5.0 ([#3431](#3431)) ([3c22f5e](3c22f5e)) * update dependency packaging to v24.2 ([#3432](#3432)) ([c1e7c81](c1e7c81)) * update docker.io/library/alpine docker tag to v3.21.0 ([#3433](#3433)) ([c8318c2](c8318c2)) * update docker.io/library/alpine:3.20.3 docker digest to 1e42bbe ([#3417](#3417)) ([0f4ef19](0f4ef19)) * update docker.io/library/maven:3.9.9-eclipse-temurin-11-alpine docker digest to 3bab9f2 ([#3447](#3447)) ([ccf7eac](ccf7eac)) * update docker.io/library/maven:3.9.9-eclipse-temurin-11-alpine docker digest to cdfb386 ([#3418](#3418)) ([2559ff8](2559ff8)) * update docker.io/library/python docker tag to v3.13.1 ([#3434](#3434)) ([feefd27](feefd27)) * update google api dependencies ([#3435](#3435)) ([3a1e8f2](3a1e8f2)) * update google auth library dependencies to v1.30.1 ([#3453](#3453)) ([d7b7dd9](d7b7dd9)) * update google http client dependencies to v1.45.2 ([#3394](#3394)) ([f8ee892](f8ee892)) * update google http client dependencies to v1.45.3 ([#3454](#3454)) ([a112559](a112559)) * update google.cloud.opentelemetry.version to v0.33.0 ([#3436](#3436)) ([e519626](e519626)) * update googleapis/java-cloud-bom digest to 93740d5 ([#3280](#3280)) ([f987db5](f987db5)) * update grpc dependencies to v1.68.2 ([#3420](#3420)) ([6d0a169](6d0a169)) * update grpc dependencies to v1.69.0 ([#3451](#3451)) ([0effb37](0effb37)) * update junit5 monorepo to v5.11.3 ([#3310](#3310)) ([4e33f2b](4e33f2b)) * update netty dependencies ([#3423](#3423)) ([22ea7b5](22ea7b5)) * update opentelemetry-java monorepo to v1.44.1 ([#3437](#3437)) ([66b85da](66b85da)) * update opentelemetry-java monorepo to v1.45.0 ([#3439](#3439)) ([d29475a](d29475a)) * update repo-automation-bots digest to 6662ddc ([#3421](#3421)) ([dec5de0](dec5de0)) * update repo-automation-bots digest to 8230b4e ([#3448](#3448)) ([e53199b](e53199b)) * update repo-automation-bots digest to ae0a72f ([#3452](#3452)) ([331bacf](331bacf)) * update repo-automation-bots digest to f3fbbab ([#3419](#3419)) ([343a029](343a029)) ### Documentation * explain default generation config in `README.md` ([#3388](#3388)) ([2ac86de](2ac86de)) * hermetic build README syntax fix ([#3391](#3391)) ([cf32e72](cf32e72)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

| Package | Type | Package file | Manager | Update | Change | |---|---|---|---|---|---| | [com.google.api.grpc:proto-google-common-protos](https://github.com/googleapis/sdk-platform-java) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `2.50.1` -> `2.51.0` | | [com.google.cloud:google-cloud-core-http](https://github.com/googleapis/sdk-platform-java) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `2.49.1` -> `2.50.0` | | [com.google.cloud:google-cloud-core](https://github.com/googleapis/sdk-platform-java) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `2.49.1` -> `2.50.0` | | [com.google.api:gax](https://github.com/googleapis/sdk-platform-java) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `2.59.1` -> `2.60.0` | | [org.apache.commons:commons-pool2](https://commons.apache.org/proper/commons-pool/) ([source](https://gitbox.apache.org/repos/asf?p=commons-pool.git)) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.12.0` -> `2.12.1` | | [software.amazon.awssdk:sdk-core](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.30.6` -> `2.30.7` | | [software.amazon.awssdk:dynamodb-enhanced](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.30.6` -> `2.30.7` | | [software.amazon.awssdk:dynamodb](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.30.6` -> `2.30.7` | | [software.amazon.awssdk:aws-core](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.30.6` -> `2.30.7` | | [software.amazon.awssdk:bom](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.30.6` -> `2.30.7` | | [software.amazon.awssdk:auth](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.30.6` -> `2.30.7` | --- ### Release Notes <details> <summary>googleapis/sdk-platform-java (com.google.api.grpc:proto-google-common-protos)</summary> ### [`v2.51.0`](https://github.com/googleapis/sdk-platform-java/blob/HEAD/CHANGELOG.md#2510-2024-12-12) ##### Features - \[iam] add ResourcePolicyMember to google/iam/v1 ([b8e2859](googleapis/sdk-platform-java@b8e2859)) ##### Bug Fixes - [#3381](googleapis/sdk-platform-java#3381) ([75dcb96](googleapis/sdk-platform-java@75dcb96)) - graalvm missing build time class when using protobuf 4.x ([#3438](googleapis/sdk-platform-java#3438)) ([f0236cf](googleapis/sdk-platform-java@f0236cf)) - return all library names if repo-level parameter changes ([#3379](googleapis/sdk-platform-java#3379)) ([75dcb96](googleapis/sdk-platform-java@75dcb96)), closes [#3381](googleapis/sdk-platform-java#3381) ##### Dependencies - update dependency com.fasterxml.jackson:jackson-bom to v2.18.2 ([#3422](googleapis/sdk-platform-java#3422)) ([fdc3a54](googleapis/sdk-platform-java@fdc3a54)) - update dependency com.google.api-client:google-api-client-bom to v2.7.1 ([#3450](googleapis/sdk-platform-java#3450)) ([35f1310](googleapis/sdk-platform-java@35f1310)) - update dependency com.google.auth:google-auth-library-oauth2-http to v1.30.0 ([#3428](googleapis/sdk-platform-java#3428)) ([78cbff1](googleapis/sdk-platform-java@78cbff1)) - update dependency com.google.errorprone:error_prone_annotations to v2.36.0 ([#3425](googleapis/sdk-platform-java#3425)) ([52dcc0d](googleapis/sdk-platform-java@52dcc0d)) - update dependency com.google.errorprone:error_prone_annotations to v2.36.0 ([#3426](googleapis/sdk-platform-java#3426)) ([77dd85d](googleapis/sdk-platform-java@77dd85d)) - update dependency dev.cel:cel to v0.8.0 ([#3429](googleapis/sdk-platform-java#3429)) ([79cde20](googleapis/sdk-platform-java@79cde20)) - update dependency io.github.java-diff-utils:java-diff-utils to v4.15 ([#3430](googleapis/sdk-platform-java#3430)) ([91fd5cb](googleapis/sdk-platform-java@91fd5cb)) - update dependency net.bytebuddy:byte-buddy to v1.15.10 ([#3298](googleapis/sdk-platform-java#3298)) ([7b503de](googleapis/sdk-platform-java@7b503de)) - update dependency org.checkerframework:checker-qual to v3.48.3 ([#3278](googleapis/sdk-platform-java#3278)) ([c5fd1b4](googleapis/sdk-platform-java@c5fd1b4)) - update dependency org.easymock:easymock to v5.5.0 ([#3431](googleapis/sdk-platform-java#3431)) ([3c22f5e](googleapis/sdk-platform-java@3c22f5e)) - update dependency packaging to v24.2 ([#3432](googleapis/sdk-platform-java#3432)) ([c1e7c81](googleapis/sdk-platform-java@c1e7c81)) - update docker.io/library/alpine docker tag to v3.21.0 ([#3433](googleapis/sdk-platform-java#3433)) ([c8318c2](googleapis/sdk-platform-java@c8318c2)) - update docker.io/library/alpine:3.20.3 docker digest to [`1e42bbe`](googleapis/sdk-platform-java@1e42bbe) ([#3417](googleapis/sdk-platform-java#3417)) ([0f4ef19](googleapis/sdk-platform-java@0f4ef19)) - update docker.io/library/maven:3.9.9-eclipse-temurin-11-alpine docker digest to [`3bab9f2`](googleapis/sdk-platform-java@3bab9f2) ([#3447](googleapis/sdk-platform-java#3447)) ([ccf7eac](googleapis/sdk-platform-java@ccf7eac)) - update docker.io/library/maven:3.9.9-eclipse-temurin-11-alpine docker digest to [`cdfb386`](googleapis/sdk-platform-java@cdfb386) ([#3418](googleapis/sdk-platform-java#3418)) ([2559ff8](googleapis/sdk-platform-java@2559ff8)) - update docker.io/library/python docker tag to v3.13.1 ([#3434](googleapis/sdk-platform-java#3434)) ([feefd27](googleapis/sdk-platform-java@feefd27)) - update google api dependencies ([#3435](googleapis/sdk-platform-java#3435)) ([3a1e8f2](googleapis/sdk-platform-java@3a1e8f2)) - update google auth library dependencies to v1.30.1 ([#3453](googleapis/sdk-platform-java#3453)) ([d7b7dd9](googleapis/sdk-platform-java@d7b7dd9)) - update google http client dependencies to v1.45.2 ([#3394](googleapis/sdk-platform-java#3394)) ([f8ee892](googleapis/sdk-platform-java@f8ee892)) - update google http client dependencies to v1.45.3 ([#3454](googleapis/sdk-platform-java#3454)) ([a112559](googleapis/sdk-platform-java@a112559)) - update google.cloud.opentelemetry.version to v0.33.0 ([#3436](googleapis/sdk-platform-java#3436)) ([e519626](googleapis/sdk-platform-java@e519626)) - update googleapis/java-cloud-bom digest to [`93740d5`](googleapis/sdk-platform-java@93740d5) ([#3280](googleapis/sdk-platform-java#3280)) ([f987db5](googleapis/sdk-platform-java@f987db5)) - update grpc dependencies to v1.68.2 ([#3420](googleapis/sdk-platform-java#3420)) ([6d0a169](googleapis/sdk-platform-java@6d0a169)) - update grpc dependencies to v1.69.0 ([#3451](googleapis/sdk-platform-java#3451)) ([0effb37](googleapis/sdk-platform-java@0effb37)) - update junit5 monorepo to v5.11.3 ([#3310](googleapis/sdk-platform-java#3310)) ([4e33f2b](googleapis/sdk-platform-java@4e33f2b)) - update netty dependencies ([#3423](googleapis/sdk-platform-java#3423)) ([22ea7b5](googleapis/sdk-platform-java@22ea7b5)) - update opentelemetry-java monorepo to v1.44.1 ([#3437](googleapis/sdk-platform-java#3437)) ([66b85da](googleapis/sdk-platform-java@66b85da)) - update opentelemetry-java monorepo to v1.45.0 ([#3439](googleapis/sdk-platform-java#3439)) ([d29475a](googleapis/sdk-platform-java@d29475a)) - update repo-automation-bots digest to [`6662ddc`](googleapis/sdk-platform-java@6662ddc) ([#3421](googleapis/sdk-platform-java#3421)) ([dec5de0](googleapis/sdk-platform-java@dec5de0)) - update repo-automation-bots digest to [`8230b4e`](googleapis/sdk-platform-java@8230b4e) ([#3448](googleapis/sdk-platform-java#3448)) ([e53199b](googleapis/sdk-platform-java@e53199b)) - update repo-automation-bots digest to [`ae0a72f`](googleapis/sdk-platform-java@ae0a72f) ([#3452](googleapis/sdk-platform-java#3452)) ([331bacf](googleapis/sdk-platform-java@331bacf)) - update repo-automation-bots digest to [`f3fbbab`](googleapis/sdk-platform-java@f3fbbab) ([#3419](googleapis/sdk-platform-java#3419)) ([343a029](googleapis/sdk-platform-java@343a029)) ##### Documentation - explain default generation config in `README.md` ([#3388](googleapis/sdk-platform-java#3388)) ([2ac86de](googleapis/sdk-platform-java@2ac86de)) - hermetic build README syntax fix ([#3391](googleapis/sdk-platform-java#3391)) ([cf32e72](googleapis/sdk-platform-java@cf32e72)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 6pm every weekday,before 2am every weekday" in timezone Australia/Melbourne, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). GitOrigin-RevId: a47f36a29b9fa1b6c892fca862b2281f6ed8ab04

docs: explain default generation config

b953dc3

product-auto-label bot added the size: s Pull request size is small. label Nov 20, 2024

JoeWang1127 marked this pull request as ready for review November 20, 2024 14:27

JoeWang1127 requested review from blakeli0 and diegomarquezp November 20, 2024 14:33

blakeli0 reviewed Nov 20, 2024

View reviewed changes

diegomarquezp approved these changes Nov 20, 2024

View reviewed changes

hermetic_build/README.md Outdated Show resolved Hide resolved

hermetic_build/README.md Outdated Show resolved Hide resolved

hermetic_build/library_generation/cli/entry_point.py Outdated Show resolved Hide resolved

JoeWang1127 added 2 commits November 20, 2024 11:55

add a prerequisite

923d3a6

rephrase after code review

c7a90e4

product-auto-label bot added size: m Pull request size is medium. and removed size: s Pull request size is small. labels Nov 20, 2024

JoeWang1127 requested a review from blakeli0 November 20, 2024 16:57

diegomarquezp approved these changes Nov 20, 2024

View reviewed changes

blakeli0 reviewed Nov 20, 2024

View reviewed changes

blakeli0 approved these changes Nov 20, 2024

View reviewed changes

JoeWang1127 merged commit 2ac86de into main Nov 20, 2024

JoeWang1127 deleted the docs/update-readme branch November 20, 2024 18:28

release-please bot mentioned this pull request Nov 19, 2024

chore(main): release 2.51.0 #3382

Merged

suztomo mentioned this pull request Nov 5, 2025

chore(2.59.x): release 2.59.3 #3982

Merged

release-please bot mentioned this pull request Dec 11, 2025

chore(protobuf-4.x-rc): release 2.65.0-rc1 #3999

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: explain default generation config in `README.md`#3388

docs: explain default generation config in `README.md`#3388
JoeWang1127 merged 3 commits intomainfrom
docs/update-readme

JoeWang1127 commented Nov 20, 2024

Uh oh!

blakeli0 Nov 20, 2024

Uh oh!

JoeWang1127 Nov 20, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Nov 20, 2024

Uh oh!

sonarqubecloud bot commented Nov 20, 2024

Uh oh!

blakeli0 Nov 20, 2024

Uh oh!

diegomarquezp Nov 20, 2024

Uh oh!

blakeli0 Nov 20, 2024

Uh oh!

JoeWang1127 Nov 20, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	def prepare_repo(
	gen_config: GenerationConfig,
	library_config: List[LibraryConfig],
	repo_path: str,
	language: str = "java",
	) -> RepoConfig:
	"""
	Gather information of the generated repository.

	:param gen_config: a GenerationConfig object representing a parsed
	configuration yaml
	:param library_config: a LibraryConfig object contained inside config,
	passed here for convenience and to prevent all libraries to be processed
	:param repo_path: the path to which the generated repository goes
	:param language: programming language of the library
	:return: a RepoConfig object contained repository information
	:raise FileNotFoundError if there's no versions.txt in repo_path
	:raise ValueError if two libraries have the same library_name
	"""

Conversation

JoeWang1127 commented Nov 20, 2024

Uh oh!

blakeli0 Nov 20, 2024

Choose a reason for hiding this comment

Uh oh!

JoeWang1127 Nov 20, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Nov 20, 2024

Quality Gate passed for 'gapic-generator-java-root'

Uh oh!

sonarqubecloud bot commented Nov 20, 2024

Quality Gate passed for 'java_showcase_integration_tests'

Uh oh!

blakeli0 Nov 20, 2024

Choose a reason for hiding this comment

Uh oh!

diegomarquezp Nov 20, 2024

Choose a reason for hiding this comment

Uh oh!

blakeli0 Nov 20, 2024

Choose a reason for hiding this comment

Uh oh!

JoeWang1127 Nov 20, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants