coreos-release-note-generator: init script for generating release notes

This script generates Fedora CoreOS release note from pre-mature release
note snippets. Takes two arguments: --config-dir and --output-dir.

The config_dir is the directory where a 'release-notes.d' directory resides,
typically a fedora-coreos-config directory, which has pre-mature release
notes yaml snippets.

The output_dir is the directory where a 'release-notes.yaml' resides. If there's
no such file then a new file will be created. If a 'release-notes.yaml' already
exists, then checks if the 'next-release' field is present in the file. It inserts
the 'next-release' field to the front of the file if none is present or updates
the existing 'next-release' field if one already exists.

Related: coreos/fedora-coreos-tracker#194
Signed-off-by: Allen Bai <abai@redhat.com>

Author: Allen Bai

coreos-release-note-generator/release-note-generator.py

@@ -0,0 +1,85 @@
+#!/usr/bin/python3 -u
+
+import yaml
+import argparse
+import os
+import glob
+
+# create the top-level parser
+parser = argparse.ArgumentParser()
+
+# create the parser for the "build" command
+parser.add_argument(
+    '--config-dir', help='FCOS config directory', required=True)
+parser.add_argument(
+    '--output-dir', help='output directory for release-notes.yaml', required=True)
+args = parser.parse_args()
+
+if not os.path.exists(args.config_dir):
+    raise Exception(
+        "config directory '{}' does not exist".format(args.config_dir))
+
+if not os.path.exists(os.path.join(args.config_dir, 'release-notes.d')):
+    raise Exception(
+        "release-notes.d does not exist under {}".format(args.config_dir))
+
+
+if not os.path.exists(args.output_dir):
+    raise Exception(
+        "output directory '{}' does not exist".format(args.output_dir))
+
+if not os.path.isdir(args.output_dir):
+    raise Exception(
+        "output path '{}' is not a directory".format(args.output_dir))
+
+snippet_yaml_list = glob.glob(os.path.join(
+    args.config_dir, 'release-notes.d/*.yaml'))
+if len(snippet_yaml_list) == 0:
+    print("release-notes.d/ does not contain any yaml snippets under '{}'".format(args.config_dir))
+    exit(0)
+
+snippet_dict = dict()
+for snippet_yaml in snippet_yaml_list:
+    with open(snippet_yaml, 'r') as f:
+        basename = os.path.basename(snippet_yaml)
+        project_name = os.path.splitext(basename)[0]
+        snippet = yaml.load(f, Loader=yaml.FullLoader)
+        snippet_dict[project_name] = snippet
+
+for project in snippet_dict.copy():
+    # filter out empty yaml file content
+    if snippet_dict[project] is None:
+        snippet_dict.pop(project, None)
+        continue
+    # eliminate note items with empty subject
+    snippet_dict[project] = [
+        note_item for note_item in snippet_dict[project] if note_item['subject']]
+    # filter empty note items
+    if len(snippet_dict[project]) == 0:
+        snippet_dict.pop(project, None)
+
+# write release-notes.yaml to the output directory
+outfile = os.path.join(args.output_dir, 'release-notes.yaml')
+# store list of release note dictionaries
+release_notes = []
+
+if os.path.exists(outfile):
+    print("{} already exists, checking 'next-release' field".format(outfile))
+    with open(outfile, 'r') as f:
+        release_notes = yaml.load(f, Loader=yaml.FullLoader)
+        # checks if the release note already exists in the yaml file
+        latest_note = release_notes[0] if len(release_notes) != 0 else dict()
+        if snippet_dict == latest_note.get("next-release", dict()):
+            print("'next-release' field already exists and no changes detected")
+            exit(0)
+
+with open(outfile, 'w') as w:
+    # check if 'next-release' item already exists
+    if len(release_notes) > 0 and "next-release" in release_notes[0]:
+        print("'next-release' field updated for {}".format(outfile))
+        release_notes[0]["next-release"] = snippet_dict
+    else:
+        # else insert the new release notes at the front of the list
+        release_notes.insert(0, {"next-release": snippet_dict})
+    yaml.dump(release_notes, w)
+    print(f"Successfully wrote release note file at {outfile}")