Skip to content

chore: GitHub Actions workflow to generate new client library #10179

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.

Sign up for GitHub

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

Merged
diegomarquezp merged 52 commits into from
Jan 17, 2024
Merged

chore: GitHub Actions workflow to generate new client library #10179

Changes from 1 commit
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
e313fee
feat: new client workflow
diegomarquezp Dec 21, 2023
181f802
define inputs to workflow
diegomarquezp Jan 12, 2024
aad1040
initial new library script
diegomarquezp Jan 12, 2024
2e1ef6a
improve input description
diegomarquezp Jan 12, 2024
f766b2c
test correct backtick syntax
diegomarquezp Jan 12, 2024
24a8b39
enclose backtick containing descriptions in double quotes
diegomarquezp Jan 12, 2024
d1fe119
remove "less necessary" inputs
diegomarquezp Jan 12, 2024
07d1762
default values for non-string inputs
diegomarquezp Jan 12, 2024
a096c7c
fix ubuntu version, remove java install
diegomarquezp Jan 12, 2024
b61577e
fix xargs and arguments
diegomarquezp Jan 12, 2024
6a53ab9
fix input-to-env list
diegomarquezp Jan 12, 2024
10f9068
correct underscores in input to new-client
diegomarquezp Jan 12, 2024
2da7fbf
add PR creation
diegomarquezp Jan 12, 2024
8855e9a
fix id typo
diegomarquezp Jan 12, 2024
9b65c2b
add gh token to pr creation step
diegomarquezp Jan 12, 2024
9e286e9
use YOSHI_CODE_BOT_TOKEN
diegomarquezp Jan 14, 2024
b93107e
use distribution_name instead of group_id
diegomarquezp Jan 14, 2024
c869604
use debug output
diegomarquezp Jan 14, 2024
7ea2f64
remove wrong push option
diegomarquezp Jan 14, 2024
8222925
sanitize token commit message
diegomarquezp Jan 15, 2024
7e9162d
specify branch in gh pr create
diegomarquezp Jan 15, 2024
03e746d
escape newlines for pr message
diegomarquezp Jan 15, 2024
72cfefa
try different newline approach
diegomarquezp Jan 15, 2024
4299d4b
improve pr description
diegomarquezp Jan 15, 2024
6611ec1
correct username to author the commits
diegomarquezp Jan 15, 2024
4d2cebb
use destination_name argument instead of cloud_api
diegomarquezp Jan 15, 2024
4c57f8f
prepare `destination-name` argument
diegomarquezp Jan 15, 2024
538b16d
correct env var setup
diegomarquezp Jan 15, 2024
4bb1dda
randomize branch name
diegomarquezp Jan 15, 2024
473c27c
correct random_id syntax
diegomarquezp Jan 15, 2024
f3fa637
add distribution-name to arguments
diegomarquezp Jan 15, 2024
9319d8b
remove dummy message step
diegomarquezp Jan 15, 2024
63607c4
include workflow location in commit message
diegomarquezp Jan 16, 2024
1d22d73
use url for workflow link
diegomarquezp Jan 16, 2024
5830b21
update new-client README
diegomarquezp Jan 16, 2024
63bf9e6
move local prerequisites to bottom
diegomarquezp Jan 16, 2024
f4e8d71
explain advanced options not called in gh action
diegomarquezp Jan 16, 2024
741e7bd
clarify advanced options note
diegomarquezp Jan 16, 2024
ce0a744
simplify readme local links
diegomarquezp Jan 16, 2024
c3ca1d2
use alternative warning format
diegomarquezp Jan 16, 2024
a9dcd70
move local example to the bottom
diegomarquezp Jan 16, 2024
ac16f1d
add links to gh action
diegomarquezp Jan 16, 2024
5d0e9c3
highlight advanced options note with warning
diegomarquezp Jan 16, 2024
b975972
add explanation on finding the generated PR
diegomarquezp Jan 16, 2024
2fb8246
correct terminology/capitalization
diegomarquezp Jan 16, 2024
097a778
improve top-to-bottom readability
diegomarquezp Jan 17, 2024
26162d0
fix "option" bias in doc
diegomarquezp Jan 17, 2024
9ef6e56
remove links for arguments
diegomarquezp Jan 17, 2024
f255a2b
punctuation
diegomarquezp Jan 17, 2024
99857c0
remove redundant advanced options explanation
diegomarquezp Jan 17, 2024
7beb584
restore principles section
diegomarquezp Jan 17, 2024
13dfea1
Merge branch 'main' into main
diegomarquezp Jan 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 29 additions & 4 deletions generation/new_client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,37 @@ google-cloud-java monorepo.

**This tool is for repository maintainers only. Not for library users.**

## Prerequisites

This section is only needed for the first run of this script. If it's already
## Run via github action

You can save the time to setup the environment by calling the
Copy link
Copy Markdown
Member

@suztomo suztomo Jan 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

You can save the time to setup the environment by calling the

This reads as if this is a good option for the reader. Would you rewrite this is the way for the reader to follow?

In other words, don't give the reader a task of determining whether they should use GitHub Actions or new-client.py script.

[`generate_new_client.yaml` github action](https://github.com/googleapis/google-cloud-java/actions/workflows/generate_new_client.yaml) directly. You can jump to
[this section](https://github.com/googleapis/google-cloud-java/blob/main/generation/new_client/README.md#run-client-generation-script)
to find workflow arguments.

> ![IMPORTANT]
> Not all the `new-client.py` arguments are available in the Github Action.
> Please refer to
> [this
> section](https://github.com/googleapis/google-cloud-java/blob/main/generation/new_client/README.md#advanced-options)
> for more arguments (it requires to setup a local environment).
> The arguments currently supported by the workflow are:
> - [API short Name (`api_shortname`)](https://github.com/googleapis/google-cloud-java/blob/main/generation/new_client/README.md#api-short-name)
> - [Proto path (`proto_path`)](https://github.com/googleapis/google-cloud-java/blob/main/generation/new_client/README.md#proto-path)
> - [Name pretty (`name_pretty`)](https://github.com/googleapis/google-cloud-java/blob/main/generation/new_client/README.md#name-pretty)
> - [Product Docs (`product_docs`)](https://github.com/googleapis/google-cloud-java/blob/main/generation/new_client/README.md#product-docs)
> - [REST Docs (`rest_docs`)](https://github.com/googleapis/google-cloud-java/blob/main/generation/new_client/README.md#rest-docs)
> - [RPC Docs (`rpc_docs`)](https://github.com/googleapis/google-cloud-java/blob/main/generation/new_client/README.md#rpc-docs)
> - [API description (`api_description`)](https://github.com/googleapis/google-cloud-java/blob/main/generation/new_client/README.md#api-description)
> - [`transport`](https://github.com/googleapis/google-cloud-java/blob/main/generation/new_client/README.md#advanced-options)
> - [`destination_name`](https://github.com/googleapis/google-cloud-java/blob/main/generation/new_client/README.md#advanced-options)
> - [`distribution_name`](https://github.com/googleapis/google-cloud-java/blob/main/generation/new_client/README.md#advanced-options)


## Prerequisites (for local environment)
Copy link
Copy Markdown
Member

@suztomo suztomo Jan 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Can you bring environment setup to the bottom? It's now not that important.

Copy link
Copy Markdown
Member

@suztomo suztomo Jan 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

'Ensure no Release Please "snapshot" pull request open', which is not environment setup, is still valid.


This section is only needed for the first _local_ run of this script. If it's already
done, go to "Run client generation script" section.


### Environment

Use Linux environment.
Expand Down