Skip to content

Commit 9e05595

Browse files
committed
Update release script to handle more headings in release notes
1 parent f20d7c9 commit 9e05595

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

scripts/release.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@
2323
=============================
2424
Next release (in development)
2525
=============================
26-
27-
* ...
2826
""".lstrip()
2927

28+
release_notes_dev_list = "* ..."
29+
3030

3131
def main(
3232
args: list[str] | None = None,
@@ -118,7 +118,7 @@ def pre_release(opts: argparse.Namespace) -> None:
118118
print(f"Renaming {release_notes_dev} to {new_release_notes}...")
119119
call('git', 'mv', str(release_notes_dev), str(new_release_notes))
120120

121-
heading_re = re.compile('.*?^=+$.*?^=+$', re.MULTILINE | re.DOTALL)
121+
heading_re = re.compile(re.escape(release_notes_dev_header + "\n"))
122122
version = opts.new_version
123123
ruler = '=' * len(version)
124124
new_heading = '\n'.join([
@@ -127,6 +127,8 @@ def pre_release(opts: argparse.Namespace) -> None:
127127
ruler,
128128
'',
129129
f'Released on {opts.release_date.isoformat()}',
130+
'',
131+
'',
130132
])
131133
replace_in_file(new_release_notes, heading_re, new_heading)
132134
call('git', 'add', str(new_release_notes))
@@ -168,6 +170,8 @@ def post_release(opts: argparse.Namespace) -> None:
168170
call('git', 'checkout', '-b', branch_name, opts.ref)
169171

170172
release_notes_dev.write_text(release_notes_dev_header)
173+
release_notes_dev.write_text("\n")
174+
release_notes_dev.write_text(release_notes_dev_list)
171175
toctree_re = re.compile(r'^\.\. toctree::$\n(^ +.*$\n)*^$\n', re.MULTILINE)
172176
replace_in_file(
173177
release_notes_index,

0 commit comments

Comments
 (0)