cloud-run-button

Let anyone deploy your GitHub repos to Google Cloud Run with a single click

  • Owner: GoogleCloudPlatform/cloud-run-button
  • Platform:
  • License:: Apache License 2.0
  • Category::
  • Topic:
  • Like:
    0
      Compare:

Github stars Tracking Chart

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 with a "hello, world" Go application (source):

Run on Google
Cloud

Demo

Cloud Run Button Demo

Add the Cloud Run Button to Your Repo's README

  1. Copy & paste this markdown:

    [![Run on Google Cloud](https://deploy.cloud.run/button.svg)](https://deploy.cloud.run)
    
  2. If the repo contains a Dockerfile, it will be built using the docker build command. Otherwise, the CNCF Buildpacks (i.e. the pack build command) will be used to build the repo (buildpack samples).

Customizing source repository parameters

  • 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.

Customizing deployment parameters

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.

Notes

  • Disclaimer: This is not an officially supported Google product.
  • See LICENSE for the licensing information.
  • See Contribution Guidelines on how to contribute.

Main metrics

Overview
Name With OwnerGoogleCloudPlatform/cloud-run-button
Primary LanguageGo
Program languageDockerfile (Language Count: 6)
Platform
License:Apache License 2.0
所有者活动
Created At2019-05-14 21:51:15
Pushed At2025-04-16 23:30:30
Last Commit At2025-04-14 09:14:10
Release Count0
用户参与
Stargazers Count536
Watchers Count32
Fork Count97
Commits Count137
Has Issues Enabled
Issues Count164
Issue Open Count46
Pull Requests Count116
Pull Requests Open Count2
Pull Requests Close Count24
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private