changelogger-cli 0.1.1

CLI tool for changelogger — generate prdocs and changelogs.
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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/anomalyco/changelogger/master/prdoc/schema_user.json",
  "title": "Changelogger PRDoc Schema",
  "description": "JSON Schema for PR documentation",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "title": {
      "title": "Title of the change",
      "type": "string",
      "description": "Title for the PR. Will show up in release notes."
    },
    "author": {
      "title": "Author handle",
      "type": "string",
      "description": "Author GitHub handle"
    },
    "pr": {
      "title": "PR number",
      "type": "integer",
      "description": "Pull request number"
    },
    "doc": {
      "type": "array",
      "title": "Documentation for audiences",
      "description": "Description of the PR for each relevant audience.",
      "items": { "$ref": "#/$defs/doc" },
      "minItems": 1
    },
    "crates": {
      "title": "Crates",
      "description": "List of crates with noticeable changes.",
      "type": "array",
      "items": { "$ref": "#/$defs/crate" }
    },
    "migrations": {
      "title": "Migrations",
      "description": "Database and runtime migrations.",
      "type": "object",
      "properties": {
        "db": { "type": "array", "items": { "$ref": "#/$defs/migration_db" } },
        "runtime": { "type": "array", "items": { "$ref": "#/$defs/migration_runtime" } }
      }
    },
    "host_functions": {
      "title": "Host Functions",
      "description": "List of host functions involved in this PR.",
      "type": "array",
      "items": { "$ref": "#/$defs/host_function" }
    }
  },
  "required": ["title", "doc", "crates"],
  "$defs": {
    "audience": {
      "oneOf": [
        { "const": "Developer" },
        { "const": "User" },
        { "const": "Operator" }
      ]
    },
    "crate": {
      "type": "object",
      "properties": {
        "name": { "type": "string" },
        "bump": { "$ref": "#/$defs/semver_bump" },
        "validate": { "type": "boolean", "default": true },
        "note": { "type": "string" }
      },
      "required": ["name", "bump"]
    },
    "semver_bump": {
      "oneOf": [
        { "const": "major" },
        { "const": "minor" },
        { "const": "patch" },
        { "const": "none" }
      ]
    },
    "doc": {
      "type": "object",
      "properties": {
        "audience": { "$ref": "#/$defs/audience" },
        "title": { "type": "string" },
        "description": { "type": "string" }
      },
      "required": ["audience", "description"]
    },
    "migration_db": {
      "type": "object",
      "properties": {
        "name": { "type": "string" },
        "description": { "type": "string" }
      },
      "required": ["name", "description"]
    },
    "migration_runtime": {
      "type": "object",
      "properties": {
        "reference": { "type": "string" },
        "description": { "type": "string" }
      },
      "required": ["description"]
    },
    "host_function": {
      "type": "object",
      "properties": {
        "name": { "type": "string" },
        "description": { "type": "string" },
        "notes": { "type": "string" }
      },
      "required": ["name", "description"]
    }
  }
}