@intentius/terragucci 0.4.7 → 0.4.9

package/dist/estate.schema.json

@@ -293,6 +293,7 @@
               "finished": { "type": "string" },
               "wave": { "type": "integer" },
               "report": { "type": "string", "description": "The wave's report.html, when the page can link it." },
+              "environment": { "type": "string", "description": "The environment of environments: in terragucci.yml the root was in when the wave applied. Absent when it was in none." },
               "resources": { "type": "array", "items": { "$ref": "#/$defs/resource" } }
             }
           }

package/dist/inventory.schema.json

@@ -19,6 +19,7 @@
           "finished": { "type": "string", "description": "When the wave that recorded the list finished." },
           "wave": { "type": "integer" },
           "path": { "type": "string", "description": "The wave's run directory, relative to the project's index.json." },
+          "environment": { "type": "string", "description": "The environment of environments: in terragucci.yml the root was in when the wave applied. Absent when it was in none." },
           "resources": {
             "type": "array",
             "items": {

package/dist/notify.schema.json

@@ -1,66 +1,72 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://intentius.io/terragucci/schemas/notify/v1/notify.schema.json",
-  "title": "terragucci.notify/v1",
-  "description": "The event terragucci notify posts to the generic webhook when a tf-apply wave waits, is refused or fails. The schema changes only when a field is removed or changes meaning; new fields can appear without a bump.",
+  "$id": "https://intentius.io/chant/schemas/notify/v1/notify.schema.json",
+  "title": "chant.notify/v1",
+  "description": "The event a notify webhook receives (#3761): a wave or environment waits for an approval, a run was refused or failed, or drift was found. Sent by chant's Op waves and by products built on chant (terragucci, SQL Yodeler) through @intentius/chant/notify, signed with HMAC-SHA256 over <timestamp>.<body>. Readers ignore fields they do not know; a field is only ever added within a version.",
   "type": "object",
-  "required": ["schema", "id", "event", "sent_at", "project", "wave", "roots"],
+  "required": ["schema", "id", "event", "at", "source", "project", "summary", "targets"],
   "properties": {
-    "schema": { "const": "terragucci.notify/v1" },
-    "id": { "type": "string", "description": "sha256 hex over the project, the wave, the event and the set digest (the commit when there is none): the same for every post of one wave's event about one digest." },
-    "event": { "enum": ["waiting", "refused", "failed"] },
-    "sent_at": { "type": "string", "description": "When the job posted it, ISO 8601." },
-    "project": { "type": "string", "description": "<host>/<path> of the repo." },
-    "forge": { "enum": ["github", "gitlab", "forgejo"] },
-    "repo": { "type": "string", "description": "owner/name on GitHub and Forgejo, the project path on GitLab." },
-    "sha": { "type": "string", "description": "The commit the wave applied." },
-    "pr": { "type": "integer", "description": "The pull or merge request the job applied, when a comment started it." },
-    "wave": { "type": "integer" },
-    "roots": { "type": "array", "items": { "type": "string" }, "description": "The wave's roots; for a refused or denied wave, the roots that moved or were denied; for a failed one, the roots that failed." },
-    "run_url": { "type": "string" },
-    "report_url": { "type": "string" },
-    "outcome": { "$ref": "#/$defs/outcome" }
-  },
-  "$defs": {
-    "outcome": {
+    "schema": { "const": "chant.notify/v1" },
+    "id": { "type": "string", "minLength": 1, "description": "The same for every send of one event about one digest (else drift fingerprint, else commit), so a receiver can drop a repeat; random when there is none. The delivery header carries it too." },
+    "event": { "enum": ["waiting", "refused", "failed", "drift"] },
+    "at": { "type": "string", "description": "When it was sent, ISO 8601 UTC." },
+    "source": { "type": "string", "minLength": 1, "description": "The product that sent it: chant, terragucci, sql-yodeler." },
+    "project": { "type": "string", "description": "What the run belongs to: the repository, or a name the product gives." },
+    "summary": { "type": "string", "description": "One line a person can read." },
+    "wave": {
       "type": "object",
-      "description": "terragucci.outcome/v1, as stage tf-apply wrote it to TG_OUTCOME_JSON.",
-      "required": ["schema", "status", "exit", "wave", "roots"],
+      "required": ["number"],
       "properties": {
-        "schema": { "const": "terragucci.outcome/v1" },
-        "status": { "enum": ["applied", "waiting", "refused", "failed"] },
-        "exit": { "type": "integer" },
-        "wave": { "type": "integer" },
-        "roots": { "type": "array", "items": { "type": "string" } },
-        "line": { "type": "string" },
-        "set_digest": { "type": "string" },
-        "gate": {
-          "type": "object",
-          "required": ["name", "branch", "path"],
-          "properties": { "name": { "type": "string" }, "branch": { "type": "string" }, "path": { "type": "string" } }
-        },
-        "approval": { "enum": ["not-requested", "waiting", "approved", "not-required"] },
-        "approval_mode": { "enum": ["ledger", "pr-review", "sealed"] },
-        "approve_command": { "type": "string" },
-        "waiting_since": { "type": "string" },
+        "number": { "type": "integer", "minimum": 1 },
+        "name": { "type": "string" },
+        "gate": { "type": "string", "description": "The gate the wave waits on." }
+      }
+    },
+    "environment": { "type": "string" },
+    "targets": { "type": "array", "items": { "type": "string" }, "description": "What the event concerns: a wave's roots or runs, an environment's pending migrations. For refused and failed, the ones refused or failed when the product knows them." },
+    "digest": { "type": "string", "description": "The plan digest an approval binds." },
+    "approve": {
+      "type": "object",
+      "description": "On waiting: how a person approves it.",
+      "required": ["command"],
+      "properties": {
+        "command": { "type": "string", "description": "The command to run, as the product prints it." },
+        "chant": { "type": "string", "description": "chant's own command for the same approval, when the product's differs." },
         "review": {
           "type": "object",
-          "required": ["pull_request", "url"],
-          "properties": { "pull_request": { "type": "integer" }, "url": { "type": "string" } }
-        },
-        "refused": {
-          "type": "object",
-          "required": ["reason", "roots"],
-          "properties": {
-            "reason": { "enum": ["approval", "review", "override", "policy"] },
-            "approved": { "type": "string" },
-            "by": { "type": "string" },
-            "roots": { "type": "array", "items": { "type": "string" } }
-          }
-        },
-        "policy_denied": { "type": "array", "items": { "type": "string" } },
-        "failed_roots": { "type": "array", "items": { "type": "string" } }
+          "description": "Under pr-review: the pull request whose approving review would approve it.",
+          "required": ["pr", "url"],
+          "properties": { "pr": { "type": "integer" }, "url": { "type": "string" } }
+        }
       }
-    }
-  }
+    },
+    "status": { "type": "string", "description": "The product's own word for the outcome." },
+    "reason": { "type": "string", "description": "On refused and failed: why." },
+    "exitCode": { "type": "integer" },
+    "drift": {
+      "type": "object",
+      "required": ["changed"],
+      "properties": {
+        "changed": { "type": "array", "items": { "type": "string" } },
+        "missing": { "type": "array", "items": { "type": "string" } },
+        "failed": { "type": "array", "items": { "type": "string" }, "description": "What could not be checked." },
+        "fingerprint": { "type": "string", "description": "The same drift has the same fingerprint, run after run." }
+      }
+    },
+    "run": {
+      "type": "object",
+      "properties": {
+        "url": { "type": "string", "description": "The CI run's page (GitHub, Forgejo) or job's page (GitLab)." },
+        "forge": { "enum": ["github", "gitlab", "forgejo"] },
+        "repository": { "type": "string" },
+        "commit": { "type": "string" },
+        "pr": { "type": "integer" }
+      }
+    },
+    "reportUrl": { "type": "string" },
+    "detail": { "type": "object", "description": "The product's own record of the outcome, carried whole (terragucci.outcome/v1)." }
+  },
+  "allOf": [
+    { "if": { "required": ["event"], "properties": { "event": { "const": "drift" } } }, "then": { "required": ["drift"], "properties": { "drift": { "type": "object" } } } }
+  ]
 }

package/dist/report.schema.json

@@ -71,6 +71,7 @@
         "required": ["path", "status", "plan_digest", "counts", "plan", "changes", "highlights", "fold", "why"],
         "properties": {
           "path": { "type": "string" },
+          "environment": { "type": "string", "description": "The environment of environments: in terragucci.yml the root is in (minor 33). Absent when the config names no environments or the root is in none." },
           "binary": {
             "description": "The binary the root ran, its version, and where the root pinned that version when it did (minor 18).",
             "type": "object",
@@ -245,7 +246,7 @@
             }
           },
           "reads": {
-            "description": "The roots whose state the root reads through terraform_remote_state, and which outputs it planned on: planned, the upstream's plan in this run, with the outputs known only once it applies under unknown; applied, its state as it stands (minor 21).",
+            "description": "The roots whose state the root reads through terraform_remote_state, or under choudoufu whose estate's outputs it reads through terraform_estate_outputs, and which outputs it planned on: planned, the upstream's plan in this run, with the outputs known only once it applies under unknown; applied, its state as it stands (minor 21).",
             "type": "array",
             "items": {
               "type": "object",
@@ -271,7 +272,27 @@
               }
             }
           },
-          "unaddressed": { "type": "string", "description": "Why the code does not address the root's own state, when a root of the run reads state through terraform_remote_state: a reader of it is not ordered after it (minor 30)." }
+          "unaddressed": { "type": "string", "description": "Why the code does not address the root's own state, when a root of the run reads state through terraform_remote_state: a reader of it is not ordered after it (minor 30)." },
+          "cone": {
+            "type": "object",
+            "description": "A choudoufu plan of a pull request's root under a live block, run with -cone=<base>: the cone it planned, or why choudoufu's guard planned the whole estate (minor 34). Absent on every other plan.",
+            "required": ["base"],
+            "properties": {
+              "base": { "type": "string", "description": "The revision the change is measured from: the pull request's base." },
+              "blocks": { "type": "integer", "description": "With a cone: the blocks it holds, when choudoufu said." },
+              "of": { "type": "integer", "description": "With a cone: the estate's blocks, when choudoufu said." },
+              "targets": { "type": "integer", "description": "With a cone: how many addresses it targets. Its targets join the root's plan digest." },
+              "fallback": {
+                "type": "object",
+                "description": "The guard planned the whole estate: its kind and why.",
+                "required": ["kind", "reason"],
+                "properties": {
+                  "kind": { "type": "string" },
+                  "reason": { "type": "string" }
+                }
+              }
+            }
+          }
         }
       }
     },
@@ -353,7 +374,8 @@
                 }
               }
             }
-          }
+          },
+          "environments": { "type": "array", "items": { "type": "string" }, "description": "The environments of environments: in terragucci.yml its roots are in, sorted (minor 33). Absent when none of its roots is in one." }
         }
       }
     },

package/dist/run.schema.json

@@ -58,7 +58,7 @@
           "reads": { "type": "array", "items": { "type": "integer" }, "description": "The waves whose roots' state its roots read." },
           "state": { "enum": ["not-started", "planned", "waiting", "applying", "applied", "refused", "failed"] },
           "gate": { "type": "string", "description": "Its gate on the ledger, wave-<n>." },
-          "policy": { "type": "string", "description": "The gate policy it ran under: always, on-destroy or never." },
+          "policy": { "type": "string", "description": "The gate policy it ran under: always, on-destructive or never." },
           "approval": { "enum": ["not-requested", "waiting", "approved", "not-required"] },
           "digest": { "type": ["string", "null"], "description": "The set digest its gate decided on." },
           "command": { "type": "string", "description": "The command that approves it, while it waits." },