Skip to content

Commit 37fa092

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. After `release-notes.yaml` has been generated / updated, all snippets under `release-notes.d` are expected to be cleaned up for future release notes. Please name the yaml file with the corresponding project name, e.g. afterburn.yaml, since the project name is determined by the yaml file name. And the release notes for a specfic version will be sorted by different project sections on the FCOS download website. For example, in the FCOS download website: --- 32.20200715.3.0: - Afterburn: fix a bug that prevents xxx (coreos/fedora-coreos-tracker#789) (details) - Ignition: introduce a new feature that improves the yyy workflow (details) - coreos-assembler: add a new sub-command that automates zzz (details) --- _Note_: Clicking on the `details` button will show the body of the release note item. [1] https://github.com/coreos/fedora-coreos-releng-automation Related: coreos/fedora-coreos-tracker#194 Signed-off-by: Allen Bai <[email protected]>
1 parent a6150cb commit 37fa092

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

release-notes.d/README

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Fedora CoreOS Release Note
2+
3+
This directory stores the Fedora CoreOS release note yaml snippets which will be picked up by
4+
`fedora-coreos-releng-automation/coreos-release-note-generator` [1] script to produce the final
5+
`release-notes.yaml` for a release. After `release-notes.yaml` has been generated / updated,
6+
all snippets under `release-notes.d` are expected to be cleaned up for future release notes.
7+
8+
Please name the yaml file with the corresponding project name, e.g. afterburn.yaml, since the project name
9+
is determined by the yaml file name. And the release notes for a specfic version will be sorted by different
10+
project sections on the FCOS download website. For example, in the FCOS download website:
11+
12+
---
13+
32.20200715.3.0:
14+
- Afterburn: fix a bug that prevents xxx (https://github.com/coreos/fedora-coreos-tracker/issues/789) (details)
15+
- Ignition: introduce a new feature that improves the yyy workflow (details)
16+
- coreos-assembler: add a new sub-command that automates zzz (details)
17+
---
18+
19+
_Note_: Clicking on the `details` button will show the body of the release note item.
20+
21+
[1] https://github.com/coreos/fedora-coreos-releng-automation

release-notes.d/project-name.yaml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Each list item should be a dictionary with structure:
2+
# - subject (required): removed package xyz
3+
# body (optional): xyz introduced bug which is related to (https://example.com/bug3).
4+
#
5+
# For example:
6+
# - subject: removed package xyz
7+
# body: This package was causing problems. Workaround by foo foo foo.
8+
# - subject: added package abc
9+
# - subject: fixed [bug3](https://example.com/bug3)
10+
11+
# item 1
12+
- subject: ""
13+
body: ""

0 commit comments

Comments
 (0)