Skip to content

Commit 9de2e49

Browse files
author
Allen Bai
committed
release-notes.d: initial directory for release note yaml snippets
This directory stores the Fedora CoreOS release note yaml snippets which will be picked up by `fedora-coreos-releng-automation/coreos-release-note-generator` [1] script to produce the final `release-notes.yaml` for a release. Related: coreos/fedora-coreos-tracker#194 Signed-off-by: Allen Bai <[email protected]>
1 parent 6854e9f commit 9de2e49

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

release-notes.d/README.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Fedora CoreOS Release Note
2+
3+
This directory stores the Fedora CoreOS release note yaml snippets which will be picked up by `fedora-coreos-releng-automation/coreos-release-note-generator` [1] script to produce `release-notes.yaml` with the corresponding latest release ID for the target stream.
4+
5+
Release notes will be organized according to the origin of the change, i.e. the project name. Otherwise miscellaneous changes will be stored under `miscellaneous`. Therefore, the schema of each yaml snippet is designed as follows:
6+
7+
```yaml
8+
# Each yaml file consists of a list of dictionaries which looks like this
9+
- component (required): [Custom Project Name] | miscellaneous
10+
subject (required): xxx
11+
body (optional): xxxxx
12+
```
13+
14+
An example `release-notes.yaml`:
15+
```
16+
- 32.20200715.3.0:
17+
coreos-assembler:
18+
- subject: add a new sub-command that automates xxx
19+
- subject: fix a bug that result in https://github.com/coreos/fedora-coreos-tracker/issues/xxx
20+
miscellaneous:
21+
- subject: introduce a new config file to facilitate xxx workflow
22+
body: the config file as described in https://github.com/coreos/fedora-coreos-tracker/issues/xxx helps users to monitor xxx
23+
- 32.20200706.3.0:
24+
afterburn:
25+
- subject: add support for platform xxx
26+
- 32.20200620.1.0:
27+
ignition:
28+
- subject: fix a minor issue https://github.com/coreos/fedora-coreos-tracker/issues/xxx
29+
...
30+
```
31+
32+
[1] https://github.com/coreos/fedora-coreos-releng-automation

release-notes.d/example.yaml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Each list item should be a dictionary with structure:
2+
# - component (required): [Custom Project Name] | miscellaneous
3+
# subject (required): xxx
4+
# body (optional): xxx
5+
#
6+
# For example:
7+
# - component: coreos-installer
8+
# subject: Retired the xxx sub-command
9+
# body: The sub-command was constantly causing xxx failure (https://github.com/coreos/fedora-coreos-tracker/issues/ISSUE_NUMBER)
10+
# - component: miscellaneous
11+
# subject: Added package abc as per (https://github.com/coreos/fedora-coreos-tracker/issues/ISSUE_NUMBER)
12+
- component: ""
13+
subject: ""
14+
body: ""

0 commit comments

Comments
 (0)