From 3afaeffdba81d187760a4afb8fa1dab6d5e1f6e7 Mon Sep 17 00:00:00 2001
From: tangkong <tangkongrobert@gmail.com>
Date: Thu, 14 Sep 2023 12:49:43 -0700
Subject: [PATCH] DOC: release notes v1.5.5, update release_notes.py

---
 docs/release_notes.py                         | 30 +++++++++++++++----
 docs/source/releases.rst                      | 14 +++++++++
 .../76-no-daq-raise.rst                       | 23 --------------
 3 files changed, 39 insertions(+), 28 deletions(-)
 delete mode 100644 docs/source/upcoming_release_notes/76-no-daq-raise.rst

diff --git a/docs/release_notes.py b/docs/release_notes.py
index 1b9f840..4b5d0ee 100644
--- a/docs/release_notes.py
+++ b/docs/release_notes.py
@@ -75,20 +75,40 @@ def extend_release_notes(path, version, release_notes):
         fd.writelines(output_lines)
 
 
-def main(version):
+def main(version_number: str):
     section_notes = parse_pre_release_file(TEMPLATE)
+    to_delete = []
     for path in PRE_RELEASE.iterdir():
         if path.name[0] in '1234567890':
+            to_delete.append(path)
             extra_notes = parse_pre_release_file(path)
             for section, notes in section_notes.items():
                 notes.extend(extra_notes[section])
                 section_notes[section] = notes
 
-    extend_release_notes(RELEASE_NOTES, version, section_notes)
+    extend_release_notes(RELEASE_NOTES, version_number, section_notes)
 
-    # git rm all of the pre-release files
-    # git add the new release notes file
+    print(
+        "* Wrote release notes.  Please perform the following manually:",
+        file=sys.stderr,
+    )
+    for path in to_delete:
+        print(f" git rm {path}", file=sys.stderr)
+    print(f" git add {RELEASE_NOTES}", file=sys.stderr)
 
 
 if __name__ == '__main__':
-    main(sys.argv[1])
+    if len(sys.argv) != 2:
+        print(f"Usage: {sys.argv[0]} VERSION_NUMBER", file=sys.stderr)
+        sys.exit(1)
+
+    version_number = sys.argv[1]
+
+    if not version_number.startswith("v"):
+        print(
+            f"Version number should start with 'v': {version_number}",
+            file=sys.stderr
+        )
+        sys.exit(1)
+
+    main(version_number)
diff --git a/docs/source/releases.rst b/docs/source/releases.rst
index b3c4740..7e0e1ec 100644
--- a/docs/source/releases.rst
+++ b/docs/source/releases.rst
@@ -2,6 +2,20 @@ Release History
 ###############
 
 
+v1.5.5 (2023-09-14)
+===================
+
+Maintenance
+-----------
+- Raise an error if the daq has not yet been initialized in the hutch-python
+  session.
+
+Contributors
+------------
+- klauer
+
+
+
 v1.5.4 (2023-07-25)
 ===================
 
diff --git a/docs/source/upcoming_release_notes/76-no-daq-raise.rst b/docs/source/upcoming_release_notes/76-no-daq-raise.rst
deleted file mode 100644
index 4ad3d5f..0000000
--- a/docs/source/upcoming_release_notes/76-no-daq-raise.rst
+++ /dev/null
@@ -1,23 +0,0 @@
-76 no-daq-raise
-#################
-
-API Changes
------------
-- N/A
-
-Features
---------
-- N/A
-
-Bugfixes
---------
-- N/A
-
-Maintenance
------------
-- Raise an error if the daq has not yet been initialized in the hutch-python
-  session.
-
-Contributors
-------------
-- klauer