If you have a public repository, you can add this button to your README.md
and
let anyone deploy your application to Google Cloud Run with a single
click.
Try it out with a "hello, world" Go application (source):
-
Copy & paste this markdown:
[![Run on Google Cloud](https://deploy.cloud.run/button.svg)](https://deploy.cloud.run)
-
If the repo contains a
Dockerfile
, it will be built using thedocker build
command. Otherwise, the CNCF Buildpacks (i.e. thepack build
command) will be used to build the repo (buildpack samples).
- When no parameters are passed, the referer is used to detect the git repo and branch
- To specify a git repo, add a
git_repo=URL
query parameter - To specify a git branch, add a
revision=BRANCH_NAME
query parameter. - To run the build in a subdirectory of the repo, add a
dir=SUBDIR
query parameter.
If you include an app.json
at the root of your repository, it allows you
customize the experience such as defining an alternative service name, or
prompting for additional environment variables.
For example:
{
"name": "foo-app",
"env": {
"BACKGROUND_COLOR": {
"description": "specify a css color",
"value": "#fefefe",
"required": false
},
"TITLE": {
"description": "title for your site"
}
}
}
Reference:
name
: (optional, default: repo name, or sub-directory name if specified) Name of the Cloud Run service and the built container image. Not validated for naming restrictions.env
: (optional) Prompt user for environment variables.description
: (optional) short explanation of what the environment variable does, keep this short to make sure it fits into a line.value
: (optional) default value for the variable, should be a string.required
, (optional, default:true
) indicates if they user must provide a value for this variable.
- Disclaimer: This is not an officially supported Google product.
- See LICENSE for the licensing information.
- See Contribution Guidelines on how to contribute.