.github/schema/changelog.schema.json at develop · lightspeedwp/.github · 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
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://lightspeedwp.com/schemas/changelog.schema.json",
  "title": "Changelog Schema",
  "description": "JSON schema for validating Keep a Changelog format CHANGELOG.md files",
  "type": "object",
  "properties": {
    "releases": {
      "type": "array",
      "description": "List of all releases in the changelog",
      "items": {
        "type": "object",
        "properties": {
          "version": {
            "type": "string",
            "pattern": "^(Unreleased|\\d+\\.\\d+\\.\\d+(?:-[a-zA-Z0-9.-]+)?)$",
            "description": "Version number or 'Unreleased'",
            "examples": ["Unreleased", "1.0.0", "0.1.0", "2.1.3-alpha"]
          },
          "date": {
            "type": "string",
            "pattern": "^(\\d{4}-\\d{2}-\\d{2}|DD-MM-YYYY|YYYY-MM-DD)$",
            "description": "Release date in YYYY-MM-DD format or placeholder",
            "examples": ["2025-11-17", "DD-MM-YYYY", "YYYY-MM-DD"]
          },
          "sections": {
            "type": "object",
            "description": "Changelog sections following Keep a Changelog format",
            "properties": {
              "added": {
                "type": "array",
                "description": "New features added",
                "items": { "type": "string" }
              },
              "changed": {
                "type": "array",
                "description": "Changes in existing functionality",
                "items": { "type": "string" }
              },
              "deprecated": {
                "type": "array",
                "description": "Soon-to-be removed features",
                "items": { "type": "string" }
              },
              "removed": {
                "type": "array",
                "description": "Removed features",
                "items": { "type": "string" }
              },
              "fixed": {
                "type": "array",
                "description": "Bug fixes",
                "items": { "type": "string" }
              },
              "security": {
                "type": "array",
                "description": "Security fixes and improvements",
                "items": { "type": "string" }
              },
              "documentation": {
                "type": "array",
                "description": "Documentation changes",
                "items": { "type": "string" }
              },
              "performance": {
                "type": "array",
                "description": "Performance improvements",
                "items": { "type": "string" }
              }
            },
            "additionalProperties": false
          }
        },
        "required": ["version", "date"],
        "additionalProperties": false
      },
      "minItems": 1
    },
    "format": {
      "type": "string",
      "enum": ["keepachangelog"],
      "description": "Changelog format standard"
    },
    "semver": {
      "type": "boolean",
      "description": "Whether the project follows Semantic Versioning"
    }
  },
  "required": ["releases"],
  "additionalProperties": true
}