Skip to content

Commit

Permalink
DOC: release notes v1.5.5, update release_notes.py
Browse files Browse the repository at this point in the history
  • Loading branch information
tangkong committed Sep 14, 2023
1 parent 47f21f1 commit 3afaeff
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 28 deletions.
30 changes: 25 additions & 5 deletions docs/release_notes.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
14 changes: 14 additions & 0 deletions docs/source/releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
===================

Expand Down
23 changes: 0 additions & 23 deletions docs/source/upcoming_release_notes/76-no-daq-raise.rst

This file was deleted.

0 comments on commit 3afaeff

Please sign in to comment.