schliflo/action-cloud-run

GitHub Action for Google Cloud Run分支部署

概述

用于Google Cloud Run分支部署的GitHub Action，可实现gcloud认证、构建并推送镜像到GCR（谷歌容器注册表），以及部署为新修订版或分支预览。支持集成GitHub Deployments和环境以显示活动实例。

核心功能和特性

• 设置cloud_run_service_url输出变量，包含服务的URL
• 可选集成GitHub Deployments和环境，显示活动实例：
  • 拉取请求（Pull Requests）
  • 环境（Environments）

使用场景和适用范围

适用于CI/CD工作流中，实现Google Cloud Run服务的自动部署与删除，支持分支预览、修订版管理及活动实例可视化，满足开发团队快速迭代和部署验证需求。

使用方法和配置说明

工作流配置示例

在GitHub Actions工作流中，检出代码步骤后插入以下配置：

yaml
- name: "Cloud Run: 部署服务"
  uses: schliflo/action-cloud-run@2.0.0
  env:
    # 若设置，将使用GitHub Deployments
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  with:
    # 必填参数
    project: your-project-id          # GCP项目ID
    service_name: your-service-name   # Cloud Run服务名称
    key: ${{ secrets.GCP_CLOUD_RUN_SERVICE_KEY }}  # GCP服务账号密钥
    # 可选设置
    action: 'deploy'                  # 操作类型，默认'deploy'
    registry: eu.gcr.io               # 容器注册表，默认eu.gcr.io
    region: europe-west1              # 区域，默认europe-west1
    platform: managed                 # 平台类型，默认managed
    working_directory: .              # 工作目录，默认.
    deploy_flags: '--allow-unauthenticated --port=80'  # 部署标志
    # 钩子（均为可选）
    hook_begin: your/script.sh
    hook_vars_before: your/script.sh
    hook_vars_after: your/script.sh
    hook_setup_before: your/script.sh
    hook_setup_after: your/script.sh
    hook_build_before: your/script.sh
    hook_build_after: your/script.sh
    hook_push_before: your/script.sh
    hook_push_after: your/script.sh
    hook_deploy_before: your/script.sh
    hook_deploy_after: your/script.sh
    hook_end: your/script.sh

权限要求

GCP_CLOUD_RUN_SERVICE_KEY密钥需为base64编码的gcloud服务密钥，具备以下权限：

• 服务账号用户（Service Account User）
• Cloud Run管理员（Cloud Run Admin）
• 存储管理员（Storage Admin）

分支删除时删除服务

yaml
- name: "Cloud Run: 删除服务"
  uses: schliflo/action-cloud-run@2.0.0
  env: 
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  with:
    project: your-project-id
    service_name: your-service-name
    key: ${{ secrets.GCP_CLOUD_RUN_SERVICE_KEY }}
    action: 'delete'  # 设置为删除操作
    # 其他可选参数与部署时相同

完整示例

部署服务工作流（deploy-cloud-run.yml）

yaml
name: "Cloud Run: 部署服务"

on:
  workflow_dispatch:
  push:

jobs:
  deploy:
    name: 部署
    runs-on: ubuntu-latest
    steps:
      - name: 检出代码
        uses: actions/checkout@v2
      - name: "Cloud Run: 部署服务"
        uses: schliflo/action-cloud-run@2.0.0
        with:
          project: ${{ secrets.GCP_PROJECT }}
          service_name: your-service-name
          key: ${{ secrets.GCP_SA_KEY }}
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

删除服务工作流（delete-cloud-run.yml）

yaml
name: "Cloud Run: 删除服务"

on:
  workflow_dispatch:
  delete:

jobs:
  delete:
    name: 删除
    runs-on: ubuntu-latest
    steps:
      - name: 检出代码
        uses: actions/checkout@v2
      - name: "Cloud Run: 删除服务"
        uses: schliflo/action-cloud-run@2.0.0
        with:
          project: ${{ secrets.GCP_PROJECT }}
          service_name: your-service-name
          key: ${{ secrets.GCP_SA_KEY }}
          action: 'delete'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}