Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: modify hermetic build docs #3331

Merged
merged 17 commits into from
Nov 5, 2024
Prev Previous commit
Next Next commit
restore param
JoeWang1127 committed Oct 31, 2024
commit 425ba11faefb8af2a7034d0b5048cf9cebf6920d
4 changes: 2 additions & 2 deletions hermetic_build/README.md
Original file line number Diff line number Diff line change
@@ -113,7 +113,7 @@ They are shared by library level parameters.
| gapic_generator_version | No | set through env variable if not specified |
| protoc_version | No | inferred from the generator if not specified |
| grpc_version | No | inferred from the generator if not specified |
| googleapis_committish | Yes | |
| googleapis_commitish | Yes | |
| libraries_bom_version | No | empty string if not specified |

### Library level parameters
@@ -137,7 +137,7 @@ They are shared by all GAPICs of a library.
| distribution_name | No | `{group_id}:google-{cloud_prefix}{library_name}` if not specified |
| excluded_poms | No | |
| excluded_dependencies | No | |
| googleapis_committish | No | use repository level `googleapis_committish` if not specified. |
| googleapis_commitish | No | use repository level `googleapis_committish` if not specified. |
Copy link
Contributor

@diegomarquezp diegomarquezp Nov 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| googleapis_commitish | No | use repository level `googleapis_committish` if not specified. |
| googleapis_commitish | No | use repository level `googleapis_commitish` if not specified. |

Not the right spelling but it's what's defined in the repo-level section.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it should be googleapis_committish according to #3208 (comment).

However, I think the refactor should be in its own PR.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I misspelled the suggestion string. I was trying to point out that we should stick to googleapis_commitish (one t) since we haven't done such refactor.

| group_id | No | `com.google.cloud` if not specified |
| issue_tracker | No | |
| library_name | No | `api_shortname` is not specified. This value should be unique among all libraries. |