feat: Add action description to UI

krab/action.go

@@ -17,6 +17,7 @@ type Action struct {
 
 	Arguments *Arguments
 
+	Description string
 	SQL         string
 	Transaction bool // wrap operation in transaction
 }
@@ -41,6 +42,10 @@ var schemaAction = &hcl.BodySchema{
 			Name:     "transaction",
 			Required: false,
 		},
+		{
+			Name:     "description",
+			Required: true,
+		},
 	},
 }
 
@@ -81,6 +86,14 @@ func (a *Action) DecodeHCL(ctx *hcl.EvalContext, block *hcl.Block) error {
 			}
 			a.SQL = val
 
+		case "description":
+			expr := krabhcl.Expression{Expr: v.Expr, EvalContext: ctx}
+			val, err := expr.String()
+			if err != nil {
+				return err
+			}
+			a.Description = val
+
 		case "transaction":
 			expr := krabhcl.Expression{Expr: v.Expr, EvalContext: ctx}
 			val, err := expr.Bool()
@@ -101,6 +114,7 @@ func (a *Action) Validate() error {
 	return ErrorCoalesce(
 		ValidateRefName(a.Namespace),
 		ValidateRefName(a.RefName),
+		ValidateStringNonEmpty("description", a.Description),
 	)
 }
 

test/fixtures/actions/actions.krab.hcl

@@ -0,0 +1,32 @@
+action "db" "create" {
+  transaction = false
+  description = "Create a database and assign database owner"
+
+  arguments {
+    arg "name" {
+      description = "Database name"
+    }
+
+    arg "user" {
+      description = "Database user"
+    }
+  }
+
+  sql = "CREATE DATABASE {{`{{ .Args.name | quote_ident }}`}} OWNER {{`{{ .Args.user | quote_ident }}`}}"
+}
+
+action "user" "create" {
+  description = "Create a database user with password"
+
+  arguments {
+    arg "user" {
+      description = "Database user"
+    }
+
+    arg "password" {
+      description = "Database password"
+    }
+  }
+
+  sql = "CREATE USER {{`{{ .Args.user | quote_ident }}`}} WITH PASSWORD {{`{{ .Args.password | quote }}`}}"
+}

test/fixtures/args/migrations.krab.hcl

@@ -34,6 +34,8 @@ migration_set "animals" {
 }
 
 action "view" "refresh" {
+  description = "Refresh a materialized view"
+
   arguments {
     arg "name" {
       description = "Materialized view to be refreshed"

views/action_list.templ

@@ -5,7 +5,7 @@ import "fmt"
 
 templ ActionList(actions []*dto.ActionListItem) {
 <h1 class="mb-4 text-xl font-semibold text-gray-700">Actions</h1>
-<div class="grid grid-cols-1 md:grid-cols-2 xl:grid-cols-3 gap-4">
+<div class="grid grid-cols-1 md:grid-cols-2 xl:grid-cols-4 gap-4">
   for _, action := range actions {
   @ActionListItem(action)
   }
@@ -25,20 +25,6 @@ templ ActionListItem(action *dto.ActionListItem) {
     </h3>
     <p class="text-sm text-muted-foreground">{ action.Description }</p>
   </div>
-  <div class="px-6 py-2">
-    <div class="flex flex-col space-y-2">
-      for _, arg := range action.Arguments {
-      <div class="flex items-center space-x-2">
-        <span class="px-2 py-1 text-sm text-black bg-white rounded">
-          { arg.Name } : { arg.Type }
-        </span>
-        <p class="text-sm text-gray-500">
-          { arg.Description }
-        </p>
-      </div>
-      }
-    </div>
-  </div>
   <div class="flex items-center p-6">
     <a href={ templ.SafeURL(fmt.Sprintf("/ui/actions/new/%s/%s", action.Namespace, action.Name)) }
       class="inline-flex items-center justify-center text-sm font-medium px-3 py-1 rounded-sm bg-rose-500 text-rose-100">

views/action_new.templ

@@ -4,9 +4,11 @@ import "github.com/ohkrab/krab/web/dto"
 import "fmt"
 
 templ ActionForm(form *dto.ActionForm) {
-<h1 class="mb-4 text-xl font-semibold text-gray-700">Run action</h1>
+<h1 class="mb-2 text-xl font-semibold text-gray-700">Run { form.Namespace }/{ form.Name } action</h1>
 <form action="/api/actions/execute" method="POST">
-  <div class="text-sm font-medium text-gray-500">{ form.Namespace } / { form.Name }</div>
+  <div class="text-sm font-medium text-gray-500">
+    { form.Description }
+  </div>
   <input type="hidden" name="id" value={ form.ExecutionID } />
   <input type="hidden" name="namespace" value={ form.Namespace } />
   <input type="hidden" name="name" value={ form.Name } />

web/dto/actions.go

@@ -15,6 +15,7 @@ type ActionListItemArgument struct {
 }
 
 type ActionForm struct {
+	Description string
 	ExecutionID string
 	Namespace   string
 	Name        string

web/server.go

@@ -255,7 +255,7 @@ func (s *Server) Run(args []string) int {
 				data = append(data, &dto.ActionListItem{
 					Namespace:   action.Namespace,
 					Name:        action.RefName,
-					Description: "",
+					Description: action.Description,
 					Transaction: action.Transaction,
 					Arguments:   args,
 				})
@@ -280,6 +280,7 @@ func (s *Server) Run(args []string) int {
 			}
 			data := dto.ActionForm{
 				ExecutionID: uuid.New().String(),
+				Description: action.Description,
 				Namespace:   action.Namespace,
 				Name:        action.RefName,
 				Arguments:   args,