Skip to content

Commit

Permalink
release-notes.d: initial directory for release note yaml snippets
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
Allen Bai committed Aug 25, 2020
1 parent 2e48f84 commit 63045f2
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
32 changes: 32 additions & 0 deletions release-notes.d/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Fedora CoreOS Release Note

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.

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:

```yaml
# Each yaml file consists of a list of dictionaries which looks like this
- component (required): [Custom Project Name] | miscellaneous
subject (required): xxx
body (optional): xxxxx
```
An example `release-notes.yaml`:
```
- 32.20200715.3.0:
coreos-assembler:
- subject: add a new sub-command that automates xxx
- subject: fix a bug that result in https://github.com/coreos/fedora-coreos-tracker/issues/xxx
miscellaneous:
- subject: introduce a new config file to facilitate xxx workflow
body: the config file as described in https://github.com/coreos/fedora-coreos-tracker/issues/xxx helps users to monitor xxx
- 32.20200706.3.0:
afterburn:
- subject: add support for platform xxx
- 32.20200620.1.0:
ignition:
- subject: fix a minor issue https://github.com/coreos/fedora-coreos-tracker/issues/xxx
...
```
[1] https://github.com/coreos/fedora-coreos-releng-automation
14 changes: 14 additions & 0 deletions release-notes.d/example.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Each list item should be a dictionary with structure:
# - component (required): [Custom Project Name] | miscellaneous
# subject (required): xxx
# body (optional): xxx
#
# For example:
# - component: coreos-installer
# subject: Retired the xxx sub-command
# body: The sub-command was constantly causing xxx failure (https://github.com/coreos/fedora-coreos-tracker/issues/ISSUE_NUMBER)
# - component: miscellaneous
# subject: Added package abc as per (https://github.com/coreos/fedora-coreos-tracker/issues/ISSUE_NUMBER)
- component: ""
subject: ""
body: ""

0 comments on commit 63045f2

Please sign in to comment.