Skip to content

Commit 5dd0b31

Browse files
author
Allen Bai
committed
release-notes.d: use [Project Name] | miscellaneous for component type
Signed-off-by: Allen Bai <[email protected]>
1 parent 91af010 commit 5dd0b31

File tree

2 files changed

+11
-19
lines changed

2 files changed

+11
-19
lines changed

release-notes.d/README

+7-9
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ This directory stores the Fedora CoreOS release note yaml snippets which will be
55
`release-notes.yaml` for a release. After `release-notes.yaml` has been generated / updated,
66
all snippets under `release-notes.d` are expected to be cleaned up for future release notes.
77

8-
Release notes will be organized according to the content of the change, e.g. which project the change
9-
was originated, which kind of change it was (e.g. general, security, bugfix). Therefore, the schema
8+
Release notes will be organized according to the origin of the change, i.e. the project name.
9+
Other miscellaneous changes will be stored under `miscellaneous`. Therefore, the schema
1010
of each yaml snippet is designed as follows:
1111

1212
```yaml
1313
# Each yaml file consists of a list of dictionaries which looks like this
14-
- component (required): [Custom Project Name] | general | bugfix | security
14+
- component (required): [Custom Project Name] | miscellaneous
1515
subject (required): xxx
1616
body (optional): xxxxx
1717
```
@@ -20,12 +20,10 @@ The final rendered version is expected to be:
2020

2121
```
2222
32.20200715.3.0:
23-
- General:
24-
introduce a new feature that improves the yyy workflow (details)
25-
- Bug Fix:
26-
fix a bug that prevents xxx (https://github.com/coreos/fedora-coreos-tracker/issues/789) (details)
27-
- coreos-assembler:
28-
add a new sub-command that automates zzz (details)
23+
- `coreos-assembler`:
24+
add a new sub-command that automates xxx (details)
25+
- Miscellaneous:
26+
introduce a new config file to facilitate xxx workflow (details)
2927
```
3028

3129
_Note_: Clicking on the `details` button will show the body of the release note item.

release-notes.d/example.yaml

+4-10
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
11
# Each list item should be a dictionary with structure:
2-
# - component (required): Ignition
3-
# subject (required): Added support for xyz
4-
# body (optional): Supporting xyz will resolve the issue filed in https://github.com/coreos/fedora-coreos-tracker/issues/ISSUE_NUMBER.
2+
# - component (required): [Custom Project Name] | miscellaneous
3+
# subject (required): xxx
4+
# body (optional): xxx
55
#
66
# For example:
77
# - component: coreos-installer
88
# subject: Retired the xxx sub-command
99
# body: The sub-command was constantly causing xxx failure (https://github.com/coreos/fedora-coreos-tracker/issues/ISSUE_NUMBER)
10-
# - component: general
10+
# - component: miscellaneous
1111
# subject: Added package abc as per (https://github.com/coreos/fedora-coreos-tracker/issues/ISSUE_NUMBER)
12-
# - component: bugfix
13-
# subject: Fixed bug https://github.com/coreos/fedora-coreos-tracker/issues/ISSUE_NUMBER
14-
# - component: security
15-
# subject: Fixed security issue https://github.com/coreos/fedora-coreos-tracker/issues/ISSUE_NUMBER
16-
17-
# Currently supported `component`: [Custom Project Name] | general | bugfix | security
1812
- component: ""
1913
subject: ""
2014
body: ""

0 commit comments

Comments
 (0)