evolith_arch32/rulesets/schema/release-notes.schema.json at main · beyondnetcode/evolith_arch32 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://evolith.dev/schema/release-notes.schema.json",
  "title": "Release Notes",
  "description": "JSON Schema for validating Evolith Release Notes artifacts. Required for Production Live gate (Phase 5).",
  "type": "object",
  "required": ["version", "releaseCandidate", "date", "scope", "deployment", "rollback", "observability"],
  "additionalProperties": false,
  "properties": {
    "version": {
      "type": "string",
      "pattern": "^\\d+\\.\\d+\\.\\d+$",
      "description": "Semantic version of this release."
    },
    "releaseCandidate": {
      "type": "string",
      "pattern": "^RC-\\d+\\.\\d+\\.\\d+$",
      "description": "RC ID this release is based on."
    },
    "date": {
      "type": "string",
      "format": "date",
      "description": "Deployment date. ISO 8601 format."
    },
    "status": {
      "type": "string",
      "enum": ["Draft", "Deployed", "Rolled Back"],
      "default": "Draft"
    },
    "scope": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "newFeatures": {
          "type": "array",
          "items": { "type": "string" }
        },
        "breakingChanges": {
          "type": "array",
          "items": { "type": "string" }
        },
        "bugFixes": {
          "type": "array",
          "items": { "type": "string" }
        },
        "improvements": {
          "type": "array",
          "items": { "type": "string" }
        }
      }
    },
    "deployment": {
      "type": "object",
      "required": ["environment", "steps", "artifacts"],
      "additionalProperties": false,
      "properties": {
        "environment": {
          "type": "string",
          "enum": ["Production", "Staging", "Canary"]
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "required": ["step", "command"],
            "additionalProperties": false,
            "properties": {
              "step": { "type": "integer" },
              "description": { "type": "string" },
              "command": { "type": "string" },
              "rollbackCommand": { "type": "string" }
            }
          },
          "minItems": 1
        },
        "artifacts": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Docker images, DLLs, or artifacts deployed."
        }
      }
    },
    "rollback": {
      "type": "object",
      "required": ["procedure", "decisionCriteria"],
      "additionalProperties": false,
      "properties": {
        "procedure": {
          "type": "array",
          "items": { "type": "string" },
          "minItems": 1
        },
        "decisionCriteria": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Conditions under which rollback must be initiated."
        },
        "lastGoodVersion": { "type": "string" }
      }
    },
    "observability": {
      "type": "object",
      "required": ["dashboards", "alerts", "healthEndpoint"],
      "additionalProperties": false,
      "properties": {
        "dashboards": {
          "type": "array",
          "items": { "type": "string", "format": "uri" }
        },
        "alerts": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Alert names or IDs activated for this release."
        },
        "healthEndpoint": { "type": "string" },
        "metricsValidation": {
          "type": "boolean",
          "description": "Whether metrics were verified nominal before sign-off."
        }
      }
    },
    "testSummaryRef": {
      "type": "string",
      "description": "Reference to Test Summary Report that validated this RC."
    },
    "signOff": {
      "type": "object",
      "required": ["devOpsLead", "techLead", "date"],
      "additionalProperties": false,
      "properties": {
        "devOpsLead": { "type": "string" },
        "techLead": { "type": "string" },
        "productOwner": { "type": "string" },
        "date": { "type": "string", "format": "date" }
      }
    }
  }
}