release-notes-schema.yml


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

## A pykwalify schema to validate the release-notes.yml file

type: seq
sequence:
  - type: map
    mapping:
      # The update "number", e.g. 0.6, 0.7. There doesn't seem to be
      # a pykwalify schema type for a semantic version number, so
      # any text is accepted.
      update:
        required: true
        type: text

      highlights:
        required: true
        type: seq
        sequence:
          - type: str

      summary:
        required: true
        type: str

      parts:
        required: false
        type: seq
        sequence:
          - type: map
            mapping:
              name:
                required: true
                type: str
              summary:
                required: true
                type: str
              projects:
                required: true
                type: seq
                sequence:
                  - type: map
                    mapping:
                      name:
                        required: true
                        type: str
                      manifest_project:
                        type: str
                      features:
                        type: seq
                        sequence:
                          - type: map
                            mapping:
                              heading:
                                required: true
                                type: str
                              summary:
                                required: true
                                type: str
                      bug_fixes:
                        type: seq
                        sequence:
                          - type: map
                            mapping:
                              heading:
                                required: true
                                type: str
                              summary:
                                required: true
                                type: str
                              cves:
                                required: false
                                type: seq
                                sequence:
                                  - type: str