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

Add --runtime argument to gcloud deploy in README. #1595

Merged
merged 4 commits into from
Jan 30, 2020
Merged

Add --runtime argument to gcloud deploy in README. #1595

merged 4 commits into from
Jan 30, 2020

Conversation

emilyaherbert
Copy link

gcloud requires a --runtime argument when deploying new functions, otherwise the user sees:

ERROR: (gcloud.functions.deploy) Missing required argument [runtime]: Flag --runtime is required for new functions.

This addition is consistent with the tutorial (https://cloud.google.com/functions/docs/tutorials/http).

@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@googlebot googlebot added the cla: no This human has *not* signed the Contributor License Agreement. label Jan 17, 2020
@emilyaherbert
Copy link
Author

@googlebot I signed it!

@googlebot
Copy link

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@googlebot googlebot added cla: yes This human has signed the Contributor License Agreement. and removed cla: no This human has *not* signed the Contributor License Agreement. labels Jan 17, 2020
@fhinkel
Copy link
Contributor

fhinkel commented Jan 21, 2020

👋 @emilyaherbert thanks for opening a pull request. @ace-n Could you have a look please. Thanks.

@ace-n
Copy link
Contributor

ace-n commented Jan 21, 2020

@labtopia what are your thoughts on this? (We'd have to keep this file up to date.)

@emilyaherbert thanks for the PR! If @labtopia is in favor of this change, would you mind updating the other files listed here as well? 🙂

cc @grant as FYI, too.

@labtopia
Copy link
Contributor

The README is inaccurate as is, so I'm in favor of fixing it. The problem with listing a specific runtime flag is that they can quickly go out of date. If you want to future-proof it, you could put a variable there instead of a hard-coded value. See what we did here:

https://cloud.google.com/functions/docs/deploying/filesystem#deploy_using_the_gcloud_tool

In the table below, we also link to the gcloud reference for the complete list of valid values for --runtime. You might want to do something like that.

@grant
Copy link
Contributor

grant commented Jan 22, 2020

Changing all gcloud functions deploy commands in this PR would be great. We should update all READMEs even if they are outdated.

@emilyaherbert
Copy link
Author

Cool beans, I'll work on this PR!

@emilyaherbert
Copy link
Author

Updated!

@ace-n
Copy link
Contributor

ace-n commented Jan 27, 2020

@emilyaherbert Thanks for updating the other files!

@labtopia would it be better to use explicit runtime versions here, given that GitHub docs are usually more focused on "getting things working" than a full conceptual explanation?

@labtopia
Copy link
Contributor

labtopia commented Jan 27, 2020

@labtopia would it be better to use explicit runtime versions here, given that GitHub docs are usually more focused on "getting things working" than a full conceptual explanation?

It's a tradeoff. You know this audience better than I do. Specifying explicit runtimes is fine; it just means the docs will go out of date more frequently, and users won't necessarily know where to look for more info when that happens.

@ace-n
Copy link
Contributor

ace-n commented Jan 27, 2020

@labtopia got it.

LGTM; @grant I assume you're cool with explicit version names?

@fhinkel fhinkel added the kokoro:run Add this label to force Kokoro to re-run the tests. label Jan 30, 2020
@kokoro-team kokoro-team removed the kokoro:run Add this label to force Kokoro to re-run the tests. label Jan 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants