Deploy to Google Cloud Run

A GitHub Action that automates building Docker images using Google Cloud Build and deploying them to Google Cloud Run with Slack notifications.

Overview

This action provides a complete CI/CD pipeline for deploying containerized applications to Google Cloud Run. It handles:

• Archiving and uploading source code to Google Cloud Storage
• Building Docker images using Google Cloud Build
• Pushing images to Google Artifact Registry
• Deploying to Google Cloud Run with custom configurations
• Sending deployment status notifications to Slack

Features

• Flexible Image Tagging: Support for custom tag formats with branch names, commit SHAs, and timestamps
• Scalable Builds: Configure Cloud Build machine types for optimal build performance
• Resource Management: Customize Cloud Run CPU, memory, and scaling configurations
• Secrets Integration: Mount secrets from Google Cloud Secrets Manager as environment variables
• VPC Support: Connect Cloud Run services to your VPC via VPC connectors
• Slack Notifications: Real-time deployment status updates
• Automatic Cleanup: Removes temporary build artifacts after deployment

Prerequisites

• Google Cloud Platform project with the following APIs enabled:
  • Cloud Build API
  • Cloud Run API
  • Cloud Storage API
  • Artifact Registry API
• GCP service account with appropriate permissions
• Slack workspace with bot token (for notifications)
• Google Cloud Storage bucket for build artifacts
• Google Artifact Registry repository

Usage

- name: Build & Deploy to Cloud Run
  uses: ./.github/actions/deploy-cloud-run
  env:
    APPLICATION: "my-app"
    ENVIRONMENT: "production"
    SLACK_BOT_TOKEN: ${{ secrets.SLACK_TOKEN }}
    SLACK_DEPLOYMENTS_CHANNEL: ${{ secrets.SLACK_DEPLOYMENTS_CHANNEL }}
  with:
    # Required inputs
    gcp-project-id: my-project-id
    gcp-service-account-key: ${{ secrets.GCP_SERVICE_ACCOUNT_KEY }}
    gcp-cloud-storage-bucket: my-build-bucket
    gcp-artifact-registry-repository: my-registry
    gcp-cloud-run-service-name: my-service
    gcp-cloud-run-port: 8080
    image-name: my-app
    image-sources: "src,package.json,Dockerfile"

    # Optional inputs
    gcp-cloud-build-machine-type: E2_HIGHCPU_32
    gcp-cloud-run-scaling-min-max: "0,10"
    gcp-cloud-run-resources-cpu-mem: "2,1Gi"
    gcp-cloud-run-max-concurrency: 80
    gcp-cloud-run-cpu-idle: true
    gcp-secrets-manager-secret-id: my-secret
    gcp-secrets-manager-secret-env-key: API_KEY
    image-path: ./Dockerfile
    image-tag-format: $BRANCH-$SHA
    image-tag-latest: true
    image-tag-additional-tags: "stable,v1.0.0"

Inputs

Required

Optional

Image Tag Format Variables

• $BRANCH - Normalized branch name
• $SHA - 7-digit commit SHA
• $YYYY - Year (4 digits)
• $MM - Month (2 digits)
• $DD - Day (2 digits)
• $HH - Hour (2 digits, 24h format)
• $mm - Minute (2 digits)
• $SS - Second (2 digits)

Outputs

How It Works

1. Archive: Creates a tarball of specified source files and uploads to Cloud Storage
2. Build: Triggers Cloud Build to create Docker image and push to Artifact Registry
3. Deploy: Creates or updates Cloud Run service with the new image
4. Notify: Sends deployment status to Slack channel
5. Cleanup: Removes temporary build artifacts from Cloud Storage

Environment Variables

The action requires the following environment variables:

• APPLICATION: Name of the application being deployed
• ENVIRONMENT: Deployment environment (e.g., staging, production)
• SLACK_BOT_TOKEN: Slack bot OAuth token
• SLACK_DEPLOYMENTS_CHANNEL: Slack channel ID for notifications

Development

Prerequisites

• Node.js 20+
• TypeScript
• npm or yarn

Setup

npm install

Build

npm run build

This compiles TypeScript to JavaScript and bundles the action using esbuild.

Lint

npm run lint        # Check for issues
npm run lintFix     # Auto-fix issues

Support

For issues or questions, please open an issue in the repository.