diff --git a/RELEASE.md b/RELEASE.md index 44e06fad..431c7210 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -41,7 +41,9 @@ for example, using the git tag for the `v1.2.0` release: git shortlog v1.2.0..HEAD -n -s ``` -Include the added/removed classes at the bottom of the release notes. Be sure to tag the release following the usual naming schema `vMAJOR.MINOR.PATCH`. +Copy the contents of `history/-/release_notes.md` file into the bottom of the release notes on GitHub. + +Be sure to tag the release following the usual naming schema `vMAJOR.MINOR.PATCH`. ## Update `brickschema` diff --git a/tools/compare_versions/compare_versions.py b/tools/compare_versions/compare_versions.py index 1a225c11..ae58aabe 100644 --- a/tools/compare_versions/compare_versions.py +++ b/tools/compare_versions/compare_versions.py @@ -217,12 +217,12 @@ def prep_concept(graph, concept): with open(history_dir / "release_notes.md", "w") as fp: fp.write("## Added Concepts\n\n```\n") for c in sorted(set(new_classes) - set(old_classes)): - fp.write(f"{c}") + fp.write(f"{c}\n") fp.write("\n```\n") fp.write("\n\n## Removed Concepts\n\n```\n") for c in sorted(set(old_classes) - set(new_classes)): - fp.write(f"{c}") + fp.write(f"{c}\n") fp.write("\n```\n") fp.write("\n\n## Deprecations\n\n")