document CreateRun

silinternational · Jun 19, 2023 · ec4303d · ec4303d
1 parent 9cfea59
commit ec4303d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/lib/run.go b/lib/run.go
@@ -11,6 +11,8 @@ type RunConfig struct {
 	WorkspaceID string
 }
 
+// CreateRun creates a Run, which starts a Plan, which can later be Applied.
+// https://developer.hashicorp.com/terraform/cloud-docs/api-docs/run
 func CreateRun(config RunConfig) error {
 	u := NewTfcUrl("/runs")
 	payload := buildRunPayload(config.Message, config.WorkspaceID)