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 dry-run command-line flag to README.md #105

Merged
merged 2 commits into from
Feb 17, 2021

Conversation

sesi
Copy link
Contributor

@sesi sesi commented Jan 20, 2021

I've been using this Functions Framework library, which has been great for developing and debugging, and noticed the --help text lists --dry-run as a command-line option though it is not documented in the README.

Support for the dry-run flag was added in version 1.1.1 (as noted in the changelog), and it may also be helpful to have it added alongside the other command-line options in the main documentation so that more users can be aware of this functionality!

@google-cla google-cla bot added the cla: yes label Jan 20, 2021
@di
Copy link
Member

di commented Jan 21, 2021

Hi @sesi, thanks for the PR. This isn't documented as we're not sure we want to officially support it and may remove it in the future.

Just curious, are you using --dry-run? If so, what for?

@sesi
Copy link
Contributor Author

sesi commented Jan 22, 2021

Hi @di - thanks for that update. I've been doing some development from the cloud shell terminal and editor and have found that --dry-run pairs well with gcloud functions deploy. It can take a few minutes to deploy cloud functions only to error out due to something like a syntax issue. So now whenever deploying from the terminal I figure I might as well chain it with a dry-run first to get immediate feedback!

something like functions-framework --dry-run && gcloud functions deploy $FUNCTION_TARGET ...

@di di merged commit 147a488 into GoogleCloudPlatform:master Feb 17, 2021
@di
Copy link
Member

di commented Feb 17, 2021

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants