Skip to content
cloud-snow

GitHub Action

Set up CloudQuery

v4.1.0 Latest version

Set up CloudQuery

cloud-snow

Set up CloudQuery

Setup CloudQuery CLI in a GitHub action environment

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Set up CloudQuery

              
  uses: cloudquery/[email protected]
Learn more about this action in cloudquery/setup-cloudquery

Choose a version

setup-cloudquery

A GitHub action to download the CloudQuery CLI so it can be used in other steps.

Prerequisites

  • We only support Linux or MacOS runners. Contributions welcomed to add Windows support 🪟
  • CloudQuery source and destination configuration files. See CloudQuery docs for more information.

Setup

Example usage:

Create a .github/workflows/cloudquery.yml file with the content of:

name: CloudQuery
on:
  schedule:
    # Run daily at 03:00 (3am)
    - cron: '0 3 * * *'

jobs:
  cloudquery:
    runs-on: ubuntu-latest
    steps:
      # Checkout a git repository with a pre-existing CloudQuery configuration files
      - uses: actions/checkout@v4

      # Setup AWS credentials (example)
      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v4
        with:
          role-to-assume: <role-arn>
          aws-region: <region>

      - uses: cloudquery/setup-cloudquery@v3
        name: Setup CloudQuery
        with:
          # Required. Must be a valid SemVer version
          version: 'v5.12.1'

      - name: Sync with CloudQuery
        run: cloudquery sync [file or directories...] --log-console