atlasaction/comments: update edit this plan comment (#252)

ariga · Oct 18, 2024 · a747e59 · a747e59
1 parent a6dae11
commit a747e59
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 14 deletions.
diff --git a/atlasaction/comments/schema-plan.tmpl b/atlasaction/comments/schema-plan.tmpl
@@ -12,15 +12,28 @@
 {{- template "schema-lint" . -}}
 <hr>
 <details>
-  <summary>📝 To edit this plan, follow these steps</summary>
-  <ol>
-    <li>Run <code>atlas schema plan pull --url "{{ .Plan.File.URL }}" > {{ .Plan.File.Name }}.plan.hcl</code></li>
-    <li>Modify the plan.</li>
-    <li>Push the plan using <code>atlas schema plan push --pending --env {{ .EnvName }} --file {{ .Plan.File.Name }}.plan.hcl</code></li>
-  {{- if .RerunCommand -}}
-    <li>Re-trigger this action using <code>{{ .RerunCommand }}</code></li>
-  {{- end -}}
-  </ol>
+<summary>📝 Steps to edit this migration plan</summary>
+
+1\. Run the following command to pull the generated plan to your local workstation:
+```bash
+atlas schema plan pull --url "{{ .Plan.File.URL }}" > {{ .Plan.File.Name }}.plan.hcl
+```
+
+2\. Open `{{ .Plan.File.Name }}` in your editor and modify it as needed. Note that the result of the plan should align
+the database with the desired state. Otherwise, Atlas will report a schema drift.
+
+3\. Push the updated plan to the registry using the following command:
+```bash
+atlas schema plan push --pending --env {{ .EnvName }} --file {{ .Plan.File.Name }}.plan.hcl
+```
+
+{{- if .RerunCommand }}
+4\. Re-trigger the `schema/plan` action to update this comment:
+```bash
+{{ .RerunCommand }}
+```
+{{- end }}
+
 </details>
 {{- define "schema-lint" -}}
 <table>

diff --git a/atlasaction/testdata/gitlab/schema-plan.txtar b/atlasaction/testdata/gitlab/schema-plan.txtar
@@ -138,9 +138,19 @@ CREATE TABLE `1` (
       <td></td>
     </tr></tbody></table><hr>
 <details>
-  <summary>📝 To edit this plan, follow these steps</summary>
-  <ol>
-    <li>Run <code>atlas schema plan pull --url "atlas://app/plans/20241010143904" > 20241010143904.plan.hcl</code></li>
-    <li>Modify the plan.</li>
-    <li>Push the plan using <code>atlas schema plan push --pending --env  --file 20241010143904.plan.hcl</code></li></ol>
+<summary>📝 Steps to edit this migration plan</summary>
+
+1\. Run the following command to pull the generated plan to your local workstation:
+```bash
+atlas schema plan pull --url "atlas://app/plans/20241010143904" > 20241010143904.plan.hcl
+```
+
+2\. Open `20241010143904` in your editor and modify it as needed. Note that the result of the plan should align
+the database with the desired state. Otherwise, Atlas will report a schema drift.
+
+3\. Push the updated plan to the registry using the following command:
+```bash
+atlas schema plan push --pending --env  --file 20241010143904.plan.hcl
+```
+
 </details>