https://github.com/ariga/gh-atlas
A GitHub CLI extension for managing Atlas workflows.
https://github.com/ariga/gh-atlas
Last synced: 2 months ago
JSON representation
A GitHub CLI extension for managing Atlas workflows.
- Host: GitHub
- URL: https://github.com/ariga/gh-atlas
- Owner: ariga
- License: apache-2.0
- Created: 2023-04-18T08:01:55.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T13:38:16.000Z (7 months ago)
- Last Synced: 2025-04-11T23:15:23.349Z (2 months ago)
- Language: Go
- Homepage:
- Size: 134 KB
- Stars: 3
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gh-atlas
A GitHub CLI extension for managing [Atlas](https://github.com/ariga/atlas) workflows.
## Getting started
To quickly set up [Atlas Cloud](https://atlasgo.cloud) CI for your repository, follow these steps:
1. Install the official `gh` CLI:
```sh
brew install gh
```
For other systems, see the [installation](https://github.com/cli/cli#installation) instructions.
2. Install this extension:
```sh
gh extension install ariga/gh-atlas
```
3. Login to GitHub:
```sh
gh auth login
```
4. 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:
```sh
gh auth refresh -s write:packages,workflow
```
5. Use the `init-action` command to set up Atlas Cloud for your repository:
```sh
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.