Merge pull request #1425 from traPtitech/conf/atlas_community

atlasのcommunity editionを使ってlintする

Author: ikura-hamu

.github/workflows/ci.yaml

@@ -95,14 +95,16 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Setup Atlas
-        uses: ariga/setup-atlas@4240bd74ba9f13319a21de2b6e497f2b6d184d76 # v0
+      - name: Setup Atlas community edition
+        run: |
+          curl -sSf https://atlasgo.sh | sh -s -- --community --yes
+        shell: bash
 
       - name: Atlas Lint
         run: |
           set +e
 
-          LINT_OUTPUT="$(atlas migrate lint --env ci 2>&1)"
+          LINT_OUTPUT="$(atlas migrate lint --config file://atlas.ci.hcl --env ci 2>&1)"
           LINT_EXIT_CODE=$?
 
           if [ "$LINT_EXIT_CODE" -eq 0 ]; then

Taskfile.yml

@@ -1,4 +1,4 @@
-version: "3"
+version: '3'
 
 includes:
   os:
@@ -92,19 +92,14 @@ tasks:
   migrate:new:
     cmds:
       - task: os:migrate:new
-    desc: "マイグレーションファイルを生成する。名前を指定できる。 (task migrate:new -- <migration_name>)"
+    desc: 'マイグレーションファイルを生成する。名前を指定できる。 (task migrate:new -- <migration_name>)'
 
   migrate:down:
     cmds:
       - task: os:migrate:down
-    desc: "マイグレーションを1つ戻して、マイグレーションファイルを削除する"
+    desc: 'マイグレーションを1つ戻して、マイグレーションファイルを削除する'
 
   migrate:down:down-only:
     cmds:
       - task: os:migrate:down:down-only
-    desc: "マイグレーションを1つ戻すが、マイグレーションファイルは削除しない"
-
-  migrate:lint:
-    cmds:
-      - task: os:migrate:lint
-    desc: "マイグレーションの Lint を実行する"
+    desc: 'マイグレーションを1つ戻すが、マイグレーションファイルは削除しない'

atlas.ci.hcl

@@ -0,0 +1,29 @@
+lint {
+  non_linear {
+    error = true
+  }
+}
+
+env "local" {
+  dev = "docker://mariadb/10.7/trap_collection"
+  
+  migration {
+    dir = "file://migrations"
+  }
+
+  lint {
+    git {
+      base = "origin/main"
+    }
+  }
+}
+
+env "ci" {
+  dev = "mysql://root:pass@localhost:3306/trap_collection"
+
+  lint {
+    git {
+      base = "origin/main"
+    }
+  }
+}

docs/migration.md

@@ -70,10 +70,12 @@ task migrate:down:down-only
 ## マイグレーションの Lint
 
 Atlas の Lint 機能を使って、マイグレーションファイルのチェックを行うことができます。
+ただし、通常の Atlas CLI の free plan では、Lint 機能を使うことができません。必要であれば community edition をインストールして使ってください。
+GitHub Actions の CI では community edition を使って Lint を実行しています。
 以下のコマンドを実行してください。
 
 ```bash
-task migrate:lint
+atlas migrate lint --config file://atlas.ci.hcl --env local
 ```
 
 このコマンドでは、main ブランチと比較してマイグレーションが正しいかをチェックします。

task/Taskfile_unix.yml

@@ -101,8 +101,3 @@ tasks:
     dir: ../
     cmds:
       - atlas migrate down --env local
-
-  migrate:lint:
-    dir: ../
-    cmds:
-      - atlas migrate lint --env local --git-base main

task/Taskfile_windows.yml

@@ -1,4 +1,4 @@
-version: "3"
+version: '3'
 
 tasks:
   download:
@@ -101,8 +101,3 @@ tasks:
     dir: ..\
     cmds:
       - atlas migrate down --env local
-
-  migrate:lint:
-    dir: ..\
-    cmds:
-      - atlas migrate lint --env local --git-base main