Google Cloud SQL Proxy

June 22, 2024 · View on GitHub

Run the Google Cloud SQL Proxy in a GitHub Action’s context

license release

Usage

Prerequisites

  • Running Cloud SQL instance with a public IP address
  • Service Account with Role Cloud SQL Client
on:
  push:
    branches: [ master ]

jobs:
  db-migrate:
    runs-on: ubuntu-latest

    steps:
      - uses: ahmadnassri/action-google-cloud-sql-proxy@v1
        with:
          key: ${{ secrets.cloud-sql-json-key }}
          connection: my-project:northamerica-northeast1:database
          port: 5432

Inputs

inputrequireddefaultdescription
key-Service Account JSON Key
token-Service Account OIDC token (if using OIDC authentication)
connection-Cloud SQL connection name
port-Listening port (MySQL: 3306, PostgreSQL: 5432, SQL Server: 1433)
version2.11.3Cloud SQL Proxy Version
sleep3time between connection checks
attempts10number of total connection checks

Note


Note: One of key or token parameters or GOOGLE_APPLICATION_CREDENTIALS env var set is required for authentication.


Author: Ahmad Nassri • Twitter: @AhmadNassri