Snowflake-CLI-GitHub-Aktion¶

Wie es funktioniert¶

Die Aktion führt folgende Schritte für den ausführenden Benutzer aus:

1. Installiert Python 3.11 und den uv-Paketmanager mit astral-sh/setup-uv.

2. Installiert Snowflake CLI in einer isolierten Umgebung (uv tool install snowflake-cli.

3. Kopiert config.toml vom Repository zu ~/.snowflake/config.toml (0600 auf Linux/macOS). Übersprungen, wenn die Datei nicht vorhanden ist.

4. Wenn die OIDC-Authentifizierung aktiviert ist, erhält sie ein von GitHub ausgestelltes OIDC-Token und legt die Umgebungsvariablen der Snowflake-Workload-Identität für nachfolgende Schritte fest.

Nachdem die Aktion abgeschlossen ist, ist der snow-Befehl auf PATH für jeden nachfolgenden Schritt im Job verfügbar.

Schnelles Nutzungsbeispiel¶

Der folgende Workflow führt die Authentifizierung bei Snowflake unter Verwendung von OIDC und einen Verbindungstest aus:

name: Deploy to Snowflake
on:
  push:
    branches:
      - main

permissions:
  id-token: write
  contents: read

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          persist-credentials: false

      - uses: snowflakedb/snowflake-cli-action@v2
        with:
          use-oidc: true
          cli-version: "3.16"

      - name: Deploy
        env:
          SNOWFLAKE_ACCOUNT: ${{ secrets.SNOWFLAKE_ACCOUNT }}
        run: |
          snow connection test -x
          snow dcm deploy --target PROD -x

Weitere Authentifizierungsmethoden finden Sie unter Authentifizierungsmethoden.

Version anheften¶

Die -Aktion unterstützt drei Pin-Stile:

• **Commit für SHA ** (@a1b2c3d...): Dies gilt für ein bestimmtes Commit.

• Patch-Version-Tag (@v2.0.2): Dies gilt für ein bestimmtes Release.

• Gleitender Major-Tag (@v2): folgt dem neuesten Release in dieser Major-Version.

# Pinned commit SHA.
- uses: snowflakedb/snowflake-cli-action@a1b2c3d4e5f67890abcdef1234567890abcdef12

# Patch version tag.
- uses: snowflakedb/snowflake-cli-action@v2.0.2

# Floating major tag.
- uses: snowflakedb/snowflake-cli-action@v2

Eingaben¶

Die Aktion akzeptiert die folgenden Eingaben, die unter with: in Ihrem -WorkflowYAML angegeben sind:

Methoden der Authentifizierung¶

Die -Aktion unterstützt drei Möglichkeiten der Authentifizierung bei Snowflake. Snowflake empfiehlt OIDC, da dadurch die Speicherung langlebiger Geheimnisse in GitHub vermieden wird.

CREATE USER <username>
  TYPE = SERVICE
  WORKLOAD_IDENTITY = (
    TYPE = OIDC
    ISSUER = 'https://token.actions.githubusercontent.com'
    SUBJECT = '<your_subject>'
  );

name: Snowflake OIDC
on:
  push:
    branches:
      - main

permissions:
  id-token: write
  contents: read

jobs:
  oidc-job:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          persist-credentials: false
      - uses: snowflakedb/snowflake-cli-action@v2
        with:
          use-oidc: true
          cli-version: "3.16"
      - name: Test connection
        env:
          SNOWFLAKE_ACCOUNT: ${{ secrets.SNOWFLAKE_ACCOUNT }}
        run: snow connection test -x

- uses: snowflakedb/snowflake-cli-action@v2
  with:
    cli-version: "3.16.0"
- name: Deploy
  env:
    SNOWFLAKE_AUTHENTICATOR: SNOWFLAKE_JWT
    SNOWFLAKE_USER: ${{ secrets.SNOWFLAKE_USER }}
    SNOWFLAKE_ACCOUNT: ${{ secrets.SNOWFLAKE_ACCOUNT }}
    SNOWFLAKE_PRIVATE_KEY_RAW: ${{ secrets.SNOWFLAKE_PRIVATE_KEY_RAW }}
    PRIVATE_KEY_PASSPHRASE: ${{ secrets.PRIVATE_KEY_PASSPHRASE }}
  run: |
    snow connection test -x
    snow dcm deploy --target PROD -x

default_connection_name = "myconnection"

[connections.myconnection]

- uses: snowflakedb/snowflake-cli-action@v2
  with:
    default-config-file-path: "config.toml"
- name: Deploy
  env:
    SNOWFLAKE_CONNECTIONS_MYCONNECTION_AUTHENTICATOR: SNOWFLAKE_JWT
    SNOWFLAKE_CONNECTIONS_MYCONNECTION_USER: ${{ secrets.SNOWFLAKE_USER }}
    SNOWFLAKE_CONNECTIONS_MYCONNECTION_ACCOUNT: ${{ secrets.SNOWFLAKE_ACCOUNT }}
    SNOWFLAKE_CONNECTIONS_MYCONNECTION_PRIVATE_KEY_RAW: ${{ secrets.SNOWFLAKE_PRIVATE_KEY_RAW }}
    PRIVATE_KEY_PASSPHRASE: ${{ secrets.PRIVATE_KEY_PASSPHRASE }}
  run: snow connection test

- uses: snowflakedb/snowflake-cli-action@v2
- name: Deploy
  env:
    SNOWFLAKE_USER: ${{ secrets.SNOWFLAKE_USER }}
    SNOWFLAKE_ACCOUNT: ${{ secrets.SNOWFLAKE_ACCOUNT }}
    SNOWFLAKE_PASSWORD: ${{ secrets.SNOWFLAKE_PASSWORD }}
  run: snow connection test -x

Installation von einem Zweig, Tag oder Commit¶

Um eine unveröffentlichte Snowflake CLI-Änderung oder einen Fork zu testen, verwenden Sie custom-github-ref:

- uses: snowflakedb/snowflake-cli-action@v2
  with:
    custom-github-ref: "feature/my-branch"  # or a tag/commit hash

Plattformunterstützung¶

Die Aktion wird auf Ubuntu-, macOS- und Windows-GitHub-gehosteten Runnern ausgeführt und wurde gegen Python 3.10 und 3.13 getestet. Beachten Sie das folgende plattformspezifische Verhalten:

• Linux und macOS: die kopierte config.toml wird auf 0600-Berechtigungen festgelegt.

• Windows: Dateiberechtigungen für config.toml werden nicht geändert. Verwenden Sie GitHub-Secrets für Anmeldeinformationen und vermeiden Sie es, Secrets in config.toml zu committen, unabhängig vom Runner.

Verwandte Ressourcen¶

• `Konfigurieren SieCI/CD-Integrationen in Snowflake<https://www.snowflake.com/en/developers/guides/configure-cicd-integrations-with-snowflake>`_. Schritt-für-Schritt-Anleitung für die Einrichtung von Snowflake CLI in einerGitHub Actions-Pipeline.

• snowflake-cli-action-Repository. Aktionsquelle und Versionshinweise.

• Integration von CI/CD mit Snowflake CLI. Übersicht aller von Snowflake unterstützten CI/CD-Integrationen.

• DevOps mit Snowflake. DevOps mit Snowflake-Konzepten und Workflow-Anleitungen.

• Workload Identity Federation. Referenz zu Snowflake Workload Identity Federation.