You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`id`|`string`| yes || A unique identifier for this entry. We recommend you generate a UUID for this field. |
52
-
|`type`|`string`| yes |`bugfix`, `feature`, `documentation`, `misc`| The type of change being made. |
53
-
|`description`|`string`| yes || A description of the change being made.<ul><li>Prefix with `**Breaking**:` if the change is breaking</li><li>Use the imperative present tense (e.g., "change" not "changed" nor "changes")</li><li>Capitalize first letter</li><li>No dot (.) at the end unless there are multiple sentences</li></ul> |
54
-
|`issues`|`string[]`| no || A list of references to any related issues in the relevant repositories. A reference can be specified in several ways:<ul><li>The issue number, if local to this repository (eg. `#12345`)</li><li>A fully-qualified issue ID (eg.`awslabs/aws-sdk-kotlin#12345`)</li><li>A fully-qualified URL (eg. `https://issuetracker.com/12345`)</li></ul> |
55
-
|`module`|`string`| no || The area of the code affected by your changes. If unsure, leave this value unset. |
49
+
| Field name | Type | Required | Enum | Description |
|`id`|`string`| yes || A unique identifier for this entry. We recommend you generate a UUID for this field. |
52
+
|`type`|`string`| yes |`bugfix`, `feature`, `documentation`, `misc`| The type of change being made. |
53
+
|`description`|`string`| yes || A description of the change being made.<ul><li>Prefix with `**Breaking**:` if the change is breaking</li><li>Use the imperative present tense (e.g., "change" not "changed" nor "changes")</li><li>Capitalize first letter</li><li>No dot (.) at the end unless there are multiple sentences</li></ul> |
54
+
|`issues`|`string[]`| no || A list of references to any related issues in the relevant repositories. A reference can be specified in several ways:<ul><li>The issue number, if local to this repository (eg. `#12345`)</li><li>A fully-qualified issue ID (eg.`awslabs/aws-sdk-kotlin#12345`)</li><li>A fully-qualified URL (eg. `https://issuetracker.com/12345`)</li></ul> |
55
+
|`module`|`string`| no || The area of the code affected by your changes. If unsure, leave this value unset. |
56
+
|`requiresMinorVersionBump`|`boolean`| no || Indicates the change will require a new minor version. This is usually the case after a breaking change. Defaults to false if flag is not included. |
56
57
57
58
The filename of an entry is arbitrary. We recommend `<id>.json`, where `<id>` corresponds to the `id` field of the entry
0 commit comments