setup-action

A GitHub Action for installing Atlas.

See the docs for other Atlas GitHub Actions for operations such as linting, syncing, or deploying your migration directory.

Usage

Add .github/workflows/deploy-schema.yaml to your repo with the following contents:

name: Deploy schema changes
run-name: I'm using Atlas 🚀
on: [push]
jobs:
  use-atlas:
    runs-on: ubuntu-latest
    steps:
      - uses: ariga/setup-atlas@master
      - run: atlas version
      # - run: atlas schema apply ... 

Inputs

Version

By default, the latest version of Atlas is being used. If you want to lock a specific version of Atlas, you can do so by specifing the version parameter.

      - uses: ariga/setup-atlas@master
        with:
            version: "vX.Y.Z"

cloud-token

The Atlas Cloud token to use for authentication. Must be passed as a secret.

      - uses: ariga/setup-atlas@master
        with:
            cloud-token: ${{ secrets.ATLAS_CLOUD_TOKEN }}

Legal

The source code for this GitHub Action is released under the Apache 2.0 License, see LICENSE.

This action downloads a binary version of Atlas which is distributed under the Ariga EULA.