action.yml

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Deploy to Cloud Run
author: Google LLC
description: |-
  Use this action to deploy a container in the Google Container Registry to Cloud Run.

inputs:
  image:
    description: |-
      Name of the container image to deploy (e.g. gcr.io/cloudrun/hello:latest).
      Required if not using a service YAML.
    required: false

  service:
    description: |-
      ID of the service or fully qualified identifier for the service.
      Required if not using a service YAML.
    required: false

  region:
    description: |-
      Region in which the resource can be found.
    required: false
    default: us-central1

  env_vars:
    description: |-
      List of key-value pairs to set as environment variables in the format:
      KEY1=VALUE1,KEY2=VALUE2. Existing environment variables will be retained.
      If both "env_vars" and "env_vars_file" are specified, the keys in
      "env_vars" will take precendence over the keys in "env_vars_files".
    required: false

  env_vars_file:
    description: |-
      Path to a file on disk, relative to the workspace, that defines
      environment variables. The file can be newline-separated KEY=VALUE pairs,
      JSON, or YAML format. If both "env_vars" and "env_vars_file" are
      specified, the keys in "env_vars" will take precendence over the keys in
      "env_vars_files".
    required: false

  secrets:
    description: |-
      List of key-value pairs to set as either environment variables or mounted
      volumes in the format:
      KEY1=secret-key-1:latest,/secrets/api/key=secret-key-2:latest. Existing
      secrets will be retained.
    required: false

  labels:
    description: |-
      List of key-value pairs to set as labels of cloud run service in the format:
      KEY1=VALUE1,KEY2=VALUE2. Existing labels will be retained.
    required: false

  skip_default_labels:
    description: |-
      Skip applying the special annotation labels that indicate the deployment
      came from GitHub Actions.
    required: false
    default: false

  metadata:
    description: |-
      YAML service description for the Cloud Run service.
    required: false

  project_id:
    description: |-
      The Google Cloud Project ID. If unset, this is inherited from the environment.
    required: false

  source:
    description: |-
      The location of the source to build. The location can be a directory on
      a local disk or a gzipped archive file (.tar.gz) in Google Cloud Storage.
      The role `Cloud Build Service Account` is required.
    required: false

  suffix:
    description: |-
      Specify the suffix of the revision name. Revision names always start with
      the service name automatically. For example, specifying 'v1' for a service
      named 'helloworld', would lead to a revision named 'helloworld-v1'.
    required: false

  tag:
    description: |-
      Traffic tag to assign to the newly created revision.
    required: false

  timeout:
    description: |-
      Set the maximum request execution time. It is specified as a duration; for
      example, "10m5s" is ten minutes and five seconds. If you don't specify a
      unit, seconds is assumed.
    required: false

  no_traffic:
    description: |-
      True to avoid sending traffic to the revision being deployed. Setting
      this flag assigns any traffic assigned to the LATEST revision to the
      specific revision bound to LATEST before the deployment. The effect is
      that the revision being deployed will not receive traffic. After a
      deployment with this flag the LATEST revision will not receive traffic
      on future deployments.
    default: false
    required: false

  revision_traffic:
    description: |-
      Comma separated list of traffic assignments in the form
      REVISION-NAME=PERCENTAGE. REVISION-NAME must be the name for a revision
      for the service as returned by 'gcloud beta run list revisions'.
      PERCENTAGE must be an integer percentage between 0 and 100 inclusive. Ex
      service-nw9hs=10,service-nw9hs=20 Up to 100 percent of traffic may be
      assigned. If 100 percent of traffic is assigned, the Service traffic is
      updated as specified. If under 100 percent of traffic is assigned, the
      Service traffic is updated as specified for revisions with assignments and
      traffic is scaled up or down down proportionally as needed for revision
      that are currently serving traffic but that do not have new assignments.
      For example assume revision-1 is serving 40 percent of traffic and
      revision-2 is serving 60 percent. If revision-1 is assigned 45 percent of
      traffic and no assignment is made for revision-2, the service is updated
      with revsion-1 assigned 45 percent of traffic and revision-2 scaled down
      to 55 percent. You can use "LATEST" as a special revision name to always
      put the given percentage of traffic on the latest ready revision
    required: false

  tag_traffic:
    description: |-
      Comma separated list of traffic assignments in the form TAG=PERCENTAGE.
      TAG must match a traffic tag on a revision of the service. PERCENTAGE must
      be an integer percentage between 0 and 100 inclusive. Up to 100 percent of
      traffic may be assigned. If 100 percent of traffic is assigned, the service
      traffic is updated as specified. If under 100 percent of traffic is
      assigned, the service traffic is updated as specified to the given tags,
      and other traffic is scaled up or down proportionally.
    required: false

  flags:
    description: |-
      Space separated list of other Cloud Run flags, examples can be found:
      https://cloud.google.com/sdk/gcloud/reference/run/deploy#FLAGS. Ex
      --service-account=my-account@project.iam.gserviceaccount.com --concurrency=10
    required: false

  gcloud_version:
    description: |-
      Version of the Cloud SDK to install. If unspecified or set to "latest",
      the latest available gcloud SDK version for the target platform will be
      installed. Example: "290.0.1".
    required: false

  gcloud_component:
    description: |-
      Version of the Cloud SDK components to install and use. If unspecified, the latest
      or released version will be used. This is the equivalent of running
      'gcloud alpha run' or 'gcloud beta run'. Valid values are `alpha` or `beta`.
    required: false

outputs:
  url:
    description: The URL of your Cloud Run service

branding:
  icon: 'chevrons-right'
  color: 'blue'

runs:
  using: 'node20'
  main: 'dist/main/index.js'