Skip to content

Commit c991dbb

Browse files
authored
docs(ci): update docs related to changelog (#1180)
chore(ci): update docs related to changelog Signed-off-by: Maksim Fedotov <maksim.fedotov@flant.com>
1 parent db151cb commit c991dbb

2 files changed

Lines changed: 22 additions & 45 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 18 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -27,47 +27,26 @@
2727

2828
## Changelog entries
2929
<!---
30-
Add one or more changelog entries to present your changes to end users.
31-
32-
Changelog entry fields description:
33-
- `section` - a project scope in the kebab-case (See CONTRIBUTING.md#scope for the list).
34-
- `type` - one of the following: fix, feature, chore
35-
- `summary` - a ONE-LINE description on how change affects users.
36-
- `impact_level` - Optional field: set to 'low' to exclude entry from changelog.
37-
- `impact` - Optional field: multiline message on what user should know in the first place, i.e. restarts, breaking changes, deprecated fields, etc. Requires `impact_level: high`.
38-
3930
/!\ See CONTRIBUTING.md for more details. /!\
40-
41-
Example 1. Significant message at the beginning of the changelog:
42-
43-
section: disks
44-
type: feat
45-
summary: "Disks serials are based on uid now."
46-
impact_level: high
47-
impact: |
48-
Disk serial is now uid-based.
49-
50-
Using /dev/disk/by-serial/ is not supported anymore.
51-
52-
53-
Example 2. Chore change (not in the Changelog):
54-
55-
section: ci
56-
type: chore
57-
summary: "Update checkout and github-script action versions."
58-
impact_level: low
59-
60-
61-
Example 3. Regular entry in the Changelog:
62-
63-
section: vm
64-
type: feature
65-
summary: "virtualMachineClassName field is now required."
66-
31+
Examples:
32+
```changes
33+
section: core
34+
type: feature
35+
summary: "Node restarts can be avoided by pinning a checksum to a node group in config values."
36+
---
37+
section: core
38+
type: fix
39+
summary: "Nodes with outdated manifests are no longer provisioned on *InstanceClass update."
40+
impact_level: high
41+
impact: |
42+
Expect nodes of "Cloud" type to restart.
43+
---
44+
impact_level: low
45+
```
6746
-->
6847

6948
```changes
70-
section:
71-
type:
72-
summary:
49+
section:
50+
type:
51+
summary:
7352
```

CONTRIBUTING.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,12 +121,12 @@ Supported scopes are the following:
121121
122122
# Maintaining, improving code quality and development workflow.
123123
- ci
124-
124+
125125
# Maintaining, improving documentation.
126126
- docs
127127
128128
# Network related changes important for end-user.
129-
- network
129+
- network
130130
```
131131
132132
#### Subject
@@ -185,12 +185,13 @@ impact: |
185185
- `feature`: Adds new functionality.
186186
- `fix`: Resolves user-facing issues.
187187
- `chore`: Maintenance tasks without direct user impact.
188+
- `docs`: Changes to documentation.
188189

189190
- **summary**: (Required) A concise explanation of the change, ending with a period.
190191

191192
- **impact_level**: (Optional) Indicates the significance of the change.
192193
- `high`: Requires an **impact** description and will be included in "Know before update" sections.
193-
- `low`: Minor changes, typically omitted from user-facing changelogs.
194+
- `low`: Minor changes, omitted from user-facing changelogs. If this level is specified, all other fields are not validated by GitHub workflow.
194195

195196
- **impact**: (Required if `impact_level` is high) Describes the change's effects, such as expected restarts or downtime.
196197
- Examples:
@@ -215,9 +216,6 @@ impact: |
215216
Node checksum calculation is fixed, as well as a race condition during
216217
the machines (MCM) rendering which caused outdated nodes to spawn.
217218
---
218-
section: ci
219-
type: fix
220-
summary: "Improved comments tracking workflow progress."
221219
impact_level: low
222220
```
223221

0 commit comments

Comments
 (0)