Skip to content

Allow your GitHub repos to deploy to Google Cloud Run in a single click

License

Notifications You must be signed in to change notification settings

ahmetb/cloud-run-button

 
 

Repository files navigation

Cloud Run Button

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:

Run on Google Cloud

Instructions

  1. Copy & paste this markdown:

    [![Run on Google Cloud](https://storage.googleapis.com/cloudrun/button.svg)](https://console.cloud.google.com/cloudshell/editor?shellonly=true&cloudshell_image=gcr.io/ahmetb-public/button&cloudshell_git_repo=YOUR_HTTP_GIT_URL)
  2. Replace YOUR_HTTP_GIT_URL with your HTTP git URL, like: https://github.com/jamesward/hello-kotlin-ktor.git

  3. Make sure the repository has a Dockerfile, so it can be built using the docker build command.

Accepting environment variables

If you need to prompt your users for some environment variables that can be used to customize the application, create an app.json file at the root of your repository, like:

{
  "env": {
      "BACKGROUND_COLOR": {
          "description": "specify a css color",
          "value": "#fefefe",
          "required": false
      },
      "TITLE": {
          "description": "title for your site",
      }
  }
}

The allowed properties on the env field are:

  • 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) indicaes if they user must provide a value for this variable.

Notes

About

Allow your GitHub repos to deploy to Google Cloud Run in a single click

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 89.9%
  • Shell 8.6%
  • Dockerfile 1.5%