fern/release-config.schema.json at main · fern-api/fern · 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
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Release Configuration",
  "description": "Configuration for managing software releases in the monorepo",
  "type": "object",
  "properties": {
    "software": {
      "type": "object",
      "description": "Map of software names to their release configurations",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Display name of the software"
          },
          "versionsFile": {
            "type": "string",
            "description": "Path to versions.yml file relative to repo root"
          },
          "changelogFolder": {
            "type": "string",
            "description": "Path to changelog folder relative to repo root (defaults to same directory as versions.yml)"
          },
          "softwareDirectory": {
            "type": "string",
            "description": "Path to software directory - changes here require changelog entries (defaults to same directory as versions.yml)"
          },
          "propagatesTo": {
            "type": "array",
            "items": { "type": "string" },
            "description": "Other software keys whose unreleased changelog should receive a propagated entry when this software is released. Used when one product embeds another (e.g. Rust SDK → CLI Generator)."
          }
        },
        "required": ["name", "versionsFile"]
      }
    }
  },
  "required": ["software"]
}