Skip to content

Commit

Permalink
readme: added information about lint (#90)
Browse files Browse the repository at this point in the history
  • Loading branch information
dorav authored Oct 8, 2023
1 parent f5c4738 commit 8248838
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,21 @@ All inputs are optional as they may be specified in the Atlas configuration file

### `ariga/atlas-action/migrate/lint`

TODO
Lint migration changes with Atlas

#### Inputs

All inputs are optional as they may be specified in the Atlas configuration file.

* `dir` - The URL of the migration directory to lint. For example: `file://migrations`.
Read more about [Atlas URLs](https://atlasgo.io/concepts/url).
* `dir-name` - The name of the project in Atlas Cloud.
* `dev-url` - The URL of the dev-database to use for analysis. For example: `mysql://root:pass@localhost:3306/dev`.
Read more about [dev-databases](https://atlasgo.io/concepts/dev-database).description: The migration directory URL (i.e file://path/to/migrations)
* `config` The path to the Atlas configuration file. By default, Atlas will look for a file
named `atlas.hcl` in the current directory. For example, `file://config/atlas.hcl`.
Learn more about [Atlas configuration files](https://atlasgo.io/atlas-schema/projects).
* `env` The environment to use from the Atlas configuration file. For example, `dev`.

### `ariga/atlas-action/migrate/apply`

Expand Down

0 comments on commit 8248838

Please sign in to comment.