coreos-release-notes-generator: init script for generating release notes #119

zonggen · 2020-08-07T18:32:38Z

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

dustymabe · 2020-08-17T19:22:39Z

Thanks @zonggen for working on this! A few questions/comments:

Can we add a nice README to this directory that explains how to use it and also what format files it expects? Some of the information from release-notes.d: initial directory for release note yaml snippets fedora-coreos-config#550 was useful in putting the pieces together.
Can we break up the file so that it uses functions more. I would break it up so that each logical piece is in its own function and there is a main function that gets run (for inspiration see https://github.com/coreos/fedora-coreos-releng-automation/blob/master/coreos-ostree-importer/coreos_ostree_importer.py#L369). Don't worry about breaking it down too much, just getting it set up that way should help it flow a bit better.

zonggen · 2020-08-17T19:27:52Z

@dustymabe Thanks for reviewing! Will cleanup the code and add a README for documentation. Also will update with the updated schema in coreos/fedora-coreos-config#550

zonggen · 2020-08-20T18:51:07Z

Removed next-release intermediate logic and added documentations.

Currently working on adding a list of file names such that no duplication between multiple testing releases, since we need yaml snippets to accumulate under release-notes.d/ for stable.

dustymabe · 2020-08-24T17:04:42Z

coreos-release-note-generator/README.md

@@ -0,0 +1,82 @@
+# coreos-release-note-generator


Should we rename to coreos-release-notes-generator?

Agreed 👍

dustymabe · 2020-08-24T17:04:53Z

coreos-release-note-generator/README.md

+`coreos-release-note-generator` generates `release-notes.yaml` from `release-notes.d` yaml snippets using the specified build id using `--build-id` option.
+
+## Options
+ - `--build-id`: build id of the latest release note


Suggested change

- `--build-id`: build id of the latest release note

- `--build-id`: build id of the latest release

dustymabe · 2020-08-24T17:09:07Z

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

+        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)


Can we return here instead of exiting in the middle of a function?

Also, we should probably consider the case where we haven't added any release-notes.d/ files for a particular release. I guess in that case we should just put an empty entry in the list saying there are not release notes or something.

Also, we should probably consider the case where we haven't added any release-notes.d/ files for a particular release. I guess in that case we should just put an empty entry in the list saying there are not release notes or something.

Or, we could just merge this list of build_id: release_notes items into a single dictionary so that we could query whether a release note exists for a release just by checking if the key build_id exists. This could be done when we are converting to JSON format for website consumption, on the other hand I think it makes sense to use YAML file for human readability on other places like fedora-coreos-config.

dustymabe · 2020-08-24T17:11:16Z

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

+                note = {'subject': item.get(
+                    'subject', ''), 'body': item.get('body', '')}
+                # purposely avoid item.get('component', '') to error out if the component key does not exist
+                project_name = item['component']


instead of using project throughout this file should we just call it component instead?

Agreed 👍

dustymabe · 2020-08-25T15:10:07Z

one small nit and then we can merge:

Change commit subject line to coreos-release-notes-generator: init script for generating release notes

`coreos-release-notes-generator` generates `release-notes.yaml` from `release-notes.d` yaml snippets using the specified build id using `--build-id` option. Supported options include: - `--build-id`(required): build id of the latest release note - `--config-dir`(required): path to the directory where `release-notes.d/` lives - `--release-notes-file`(optional): path to the input `release-notes.yaml` file for update, the script uses this option to determine whether to update an existing `release-notes.yaml` or to create a new one. By default create a new `release-notes.yaml` - `--output-dir`(optional): output directory for `release-notes.yaml`, by default outputs to STDOUT - `--json`(optional): output JSON format instead of YAML for easier consumption by Fedora CoreOS website (https://getfedora.org/en/coreos?stream=stable), by default uses YAML Related: coreos/fedora-coreos-tracker#194 Signed-off-by: Allen Bai <abai@redhat.com>

zonggen · 2020-08-25T16:32:38Z

Fixed commit subject, thanks for pointing that out!

dustymabe · 2020-08-25T17:27:10Z

LGTM - I think we can merge this and do fixups for things we find in a followup PR.

dustymabe

LGTM

zonggen force-pushed the fcos-release-notes branch 3 times, most recently from c83c744 to e37a70a Compare August 7, 2020 19:10

zonggen mentioned this pull request Aug 7, 2020

Release notes coreos/fedora-coreos-tracker#194

Closed

zonggen force-pushed the fcos-release-notes branch 2 times, most recently from 310170f to c985d06 Compare August 10, 2020 18:40

zonggen changed the title ~~[WIP] coreos-release-note-generator: init script for generating release notes~~ coreos-release-note-generator: init script for generating release notes Aug 10, 2020

dustymabe mentioned this pull request Aug 18, 2020

release-notes.d: initial directory for release note yaml snippets coreos/fedora-coreos-config#550

Open

zonggen force-pushed the fcos-release-notes branch from ec2edc6 to fa5f509 Compare August 20, 2020 18:45

dustymabe reviewed Aug 24, 2020

View reviewed changes

zonggen force-pushed the fcos-release-notes branch from fa5f509 to 6389966 Compare August 24, 2020 18:42

zonggen force-pushed the fcos-release-notes branch from 6389966 to 28376c3 Compare August 25, 2020 16:31

dustymabe changed the title ~~coreos-release-note-generator: init script for generating release notes~~ coreos-release-notes-generator: init script for generating release notes Aug 25, 2020

dustymabe approved these changes Aug 25, 2020

View reviewed changes

dustymabe merged commit 6d7d0b0 into coreos:master Aug 25, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

coreos-release-notes-generator: init script for generating release notes #119

coreos-release-notes-generator: init script for generating release notes #119

Uh oh!

zonggen commented Aug 7, 2020 •

edited

Loading

Uh oh!

dustymabe commented Aug 17, 2020

Uh oh!

zonggen commented Aug 17, 2020

Uh oh!

zonggen commented Aug 20, 2020

Uh oh!

dustymabe Aug 24, 2020

Uh oh!

zonggen Aug 24, 2020

Uh oh!

dustymabe Aug 24, 2020

Uh oh!

dustymabe Aug 24, 2020

Uh oh!

dustymabe Aug 24, 2020

Uh oh!

zonggen Aug 24, 2020 •

edited

Loading

Uh oh!

dustymabe Aug 24, 2020

Uh oh!

zonggen Aug 24, 2020

Uh oh!

dustymabe commented Aug 25, 2020

Uh oh!

zonggen commented Aug 25, 2020

Uh oh!

dustymabe commented Aug 25, 2020

Uh oh!

dustymabe left a comment

Uh oh!

Uh oh!

	- `--build-id`: build id of the latest release note
	- `--build-id`: build id of the latest release

coreos-release-notes-generator: init script for generating release notes #119

coreos-release-notes-generator: init script for generating release notes #119

Uh oh!

Conversation

zonggen commented Aug 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dustymabe commented Aug 17, 2020

Uh oh!

zonggen commented Aug 17, 2020

Uh oh!

zonggen commented Aug 20, 2020

Uh oh!

dustymabe Aug 24, 2020

Choose a reason for hiding this comment

Uh oh!

zonggen Aug 24, 2020

Choose a reason for hiding this comment

Uh oh!

dustymabe Aug 24, 2020

Choose a reason for hiding this comment

Uh oh!

dustymabe Aug 24, 2020

Choose a reason for hiding this comment

Uh oh!

dustymabe Aug 24, 2020

Choose a reason for hiding this comment

Uh oh!

zonggen Aug 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dustymabe Aug 24, 2020

Choose a reason for hiding this comment

Uh oh!

zonggen Aug 24, 2020

Choose a reason for hiding this comment

Uh oh!

dustymabe commented Aug 25, 2020

Uh oh!

zonggen commented Aug 25, 2020

Uh oh!

dustymabe commented Aug 25, 2020

Uh oh!

dustymabe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zonggen commented Aug 7, 2020 •

edited

Loading

zonggen Aug 24, 2020 •

edited

Loading