From 63045f2eac349dee10b7cc1f7f6589a7d61de251 Mon Sep 17 00:00:00 2001 From: Allen Bai Date: Fri, 7 Aug 2020 15:42:24 -0400 Subject: [PATCH] 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: https://github.com/coreos/fedora-coreos-tracker/issues/194 Signed-off-by: Allen Bai --- release-notes.d/README.md | 32 ++++++++++++++++++++++++++++++++ release-notes.d/example.yaml | 14 ++++++++++++++ 2 files changed, 46 insertions(+) create mode 100644 release-notes.d/README.md create mode 100644 release-notes.d/example.yaml diff --git a/release-notes.d/README.md b/release-notes.d/README.md new file mode 100644 index 0000000000..cda9121a4d --- /dev/null +++ b/release-notes.d/README.md @@ -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 diff --git a/release-notes.d/example.yaml b/release-notes.d/example.yaml new file mode 100644 index 0000000000..0438f1fff4 --- /dev/null +++ b/release-notes.d/example.yaml @@ -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: ""