ENG-1235: Added more info to module docstring, about release tagging

RasaHQ · Aug 22, 2024 · 028ebf6 · 028ebf6
1 parent e1b7666
commit 028ebf6
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/scripts/release.py b/scripts/release.py
@@ -3,7 +3,10 @@
 - creates a new changelog section in CHANGELOG.mdx based on all collected changes
 - increases the version number
 - pushes the new branch to GitHub
-- Tags the release and pushes tag to GitHub
+
+When run with `--tag`:
+- tags the current commit with the version number found in the version module
+- and pushes the tag to GitHub.
 """
 
 import argparse