Skip to content
/ gh-atlas Public

A GitHub CLI extension for managing Atlas workflows.

License

Notifications You must be signed in to change notification settings

ariga/gh-atlas

Repository files navigation

gh-atlas

A GitHub CLI extension for managing Atlas workflows.

Getting started

To quickly set up Atlas Cloud CI for your repository, follow these steps:

  1. Install the official gh CLI:
brew install gh

For other systems, see the installation instructions. 2. Install this extension:

gh extension install ariga/gh-atlas
  1. Login to GitHub:
gh auth login
  1. Setting up Atlas Cloud for your repository requires creating new GitHub Actions workflows.
    To do this, you need add the following permissions to your GitHub CLI:
gh auth refresh -s write:packages,workflow
  1. Use the init-action command to set up Atlas Cloud for your repository:
gh atlas init-action

This will create a new workflow in your repository, which will run on every push to the your mainline branch.
You can customize the workflow by editing the .github/workflows/ci-atlas.yml file.