Skip to content

Commit 984dc4e

Browse files
committed
Expand script description
1 parent 52c9276 commit 984dc4e

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

scripts/release_notes.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,15 @@ def generate_release_notes(
9292

9393

9494
if __name__ == "__main__":
95-
parser = argparse.ArgumentParser(description="Generate release notes from draft release")
95+
# TODO: When the script is sufficiently polished, we may automate draft release generation and its update,
96+
# and integrate the script into the CI.
97+
parser = argparse.ArgumentParser(
98+
description=(
99+
"Generate expanded `dstack` release notes from a release draft using LLM."
100+
" The script accepts a release tag for which you must generate automatic release notes beforehand."
101+
" The script does not publish or change anything on GitHub and only outputs the generated release notes."
102+
)
103+
)
96104
parser.add_argument("tag", help="Release tag (e.g., 0.19.25)")
97105
args = parser.parse_args()
98106

0 commit comments

Comments
 (0)