chore: update instructions on generate_repo.py
#2449
Merged
Conversation
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
JoeWang1127
changed the title
generate_repo.py
library_generation/README.md
Outdated
| will be generated; otherwise all libraries in the configuration file will be | ||
| generated. | ||
| This can be useful when you just want to generate one library for debugging | ||
| purpose. |
There was a problem hiding this comment.
Suggested change
| purpose. | |
| purposes. |
|
|
||
| The path to where the generated repository goes. | ||
|
|
||
| The default value is the current working directory when running the script. |
There was a problem hiding this comment.
Suggested change
| The default value is the current working directory when running the script. | |
| The default value is the current working directory when running the script. For example, `cd google-cloud-java && python generate_repo.py ...` without specifying the `--repository_path` option will modify the `google-cloud-java` repository the user `cd`'d into. |
Just a redundant explanation to clarify.
| Please refer [here](go/java-client-releasing#versionstxt-manifest) for more info | ||
| of versions.txt. | ||
|
|
||
| ## Output of `generate_repo.py` |
There was a problem hiding this comment.
Suggested change
| ## Output of `generate_repo.py` | |
| ## Output of `generate_repo.py` | |
| For each module (e.g. `google-cloud-java/java-asset`), the following files/folders will be created/modified |
Comment on lines
+87
to
+89
| | googleapis-commitish | Yes | | | ||
| | owlbot-cli-image | Yes | | | ||
| | synthtool-commitish | Yes | | |
There was a problem hiding this comment.
Suggested change
| | googleapis-commitish | Yes | | | |
| | owlbot-cli-image | Yes | | | |
| | synthtool-commitish | Yes | | | |
| | googleapis_commitish | Yes | | | |
| | owlbot_cli_image | Yes | | | |
| | synthtool_commitish | Yes | | | |
| | template_excludes | Yes | | |
Hope you don't mind if I add template_excludes which will be merged soon
library_generation/README.md
Outdated
|
|
||
| ```bash | ||
| # install python module |
There was a problem hiding this comment.
Suggested change
| # install python module | |
| # install python module (allows the `library_generation` module to be imported from anywhere) | |
| python -m pip install library_generation | |
| # install dependencies |
Although it may not be necessary for some setups, installing via setup.py may be safer so the module can be ensured to be importable
diegomarquezp
approved these changes
Feb 8, 2024
| googleapis_commitish: 1a45bf7393b52407188c82e63101db7dc9c72026 | ||
| owlbot_cli_image: sha256:623647ee79ac605858d09e60c1382a716c125fb776f69301b72de1cd35d49409 | ||
| synthtool_commitish: 6612ab8f3afcd5e292aecd647f0fa68812c9f5b5 | ||
| destination_path: google-cloud-java |
There was a problem hiding this comment.
Suggested change
| destination_path: google-cloud-java | |
| destination_path: google-cloud-java | |
| template_excludes: | |
| - ".github/*" | |
| - ".kokoro/*" | |
| - "samples/*" | |
| - "CODE_OF_CONDUCT.md" | |
| - "CONTRIBUTING.md" | |
| - "LICENSE" | |
| - "SECURITY.md" | |
| - "java.header" | |
| - "license-checks.xml" | |
| - "renovate.json" | |
| - ".gitignore" |
There was a problem hiding this comment.
forgot to add an example for this one
|
|
ddixit14
pushed a commit
that referenced
this pull request
Feb 15, 2024
In this PR: - Update instructions on `generate_repo.py`.
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.
In this PR:
generate_repo.py.