From 17b96974a334688f76b57d350e07cae8cda46877 Mon Sep 17 00:00:00 2001
From: bashonly <88596187+bashonly@users.noreply.github.com>
Date: Thu, 14 Mar 2024 16:10:20 -0500
Subject: [build] Update changelog for tarball and sdist (#9425)

Closes #9417
Authored by: bashonly
---
 devscripts/update_changelog.py | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100755 devscripts/update_changelog.py

(limited to 'devscripts/update_changelog.py')

diff --git a/devscripts/update_changelog.py b/devscripts/update_changelog.py
new file mode 100755
index 000000000..36b9a8e86
--- /dev/null
+++ b/devscripts/update_changelog.py
@@ -0,0 +1,26 @@
+#!/usr/bin/env python3
+
+# Allow direct execution
+import os
+import sys
+
+sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+
+from pathlib import Path
+
+from devscripts.make_changelog import create_changelog, create_parser
+from devscripts.utils import read_file, read_version, write_file
+
+# Always run after devscripts/update-version.py, and run before `make doc|pypi-files|tar|all`
+
+if __name__ == '__main__':
+    parser = create_parser()
+    parser.description = 'Update an existing changelog file with an entry for a new release'
+    parser.add_argument(
+        '--changelog-path', type=Path, default=Path(__file__).parent.parent / 'Changelog.md',
+        help='path to the Changelog file')
+    args = parser.parse_args()
+    new_entry = create_changelog(args)
+
+    header, sep, changelog = read_file(args.changelog_path).partition('\n### ')
+    write_file(args.changelog_path, f'{header}{sep}{read_version()}\n{new_entry}\n{sep}{changelog}')
-- 
cgit v1.2.3