updated readme

Dazu-io · Nov 27, 2019 · 31a267f · 31a267f
1 parent a316269
commit 31a267f
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -138,15 +138,13 @@ Releasing a new version is quite simple, as the packages are build and distribut
 * major release (first version part increases): 1.2.0 -> 2.0.0
 
 *Release steps*:
-1. Create a new branch and 
-
-  * Update [rasa/version.py](https://github.com/RasaHQ/rasa/blob/master/rasa/version.py) to reflect the correct version number
-  * Edit the [CHANGELOG.rst](https://github.com/RasaHQ/rasa/blob/master/CHANGELOG.rst), create a new section for the release (eg by moving the items from the collected master section) and create a new master logging section
-  * Edit the [migration guide](https://github.com/RasaHQ/rasa/blob/master/docs/migration-guide.rst) to provide assistance for users updating to the new version
-2. Commit the changes and create a PR against master or the release branch (e.g. `1.2.x`)
+0. Make sure all dependencies are up to date (**especially Rasa SDK**)
+1. Switch to the branch you want to cut the release from.
+2. Run `make release`
+2. Create a PR against master or the release branch (e.g. `1.2.x`)
 3. Once your PR is merged, tag a new release (this SHOULD always happen on master or release branches), e.g. using
     ```
-    git tag 1.2.0 -m "Some helpful line describing the release"
+    git tag 1.2.0 -m "next release"
     git push origin 1.2.0 --tags
     ```
     travis will build this tag and push a package to [pypi](https://pypi.python.org/pypi/rasa)

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -28,6 +28,4 @@ azure-storage-blob==1.0.0
 coveralls==1.7.0
 
 # release tools
-pypandoc==1.4
-github3==1.3.0
 semantic_version==2.8.3
diff --git a/scripts/release.py b/scripts/release.py
@@ -1,3 +1,10 @@
+"""Prepare a Rasa OSS release.
+
+- creates a release branch
+- creates a new changelog section in CHANGELOG.rst based on all collected changes
+- increases the version number
+- pushes the new branch to GitHub
+"""
 import argparse
 import os
 import sys
@@ -76,7 +83,8 @@ def confirm_version(version: Text) -> bool:
     else:
         confirmed = questionary.confirm(
             f"Is the next version '{version}' correct "
-            f"(current version is '{get_current_version()}')?", default=True
+            f"(current version is '{get_current_version()}')?",
+            default=True,
         ).ask()
     if confirmed:
         return True
@@ -193,6 +201,11 @@ def print_done_message(branch: Text, base: Text, version: Text) -> None:
 def main(args: argparse.Namespace) -> None:
     """Start a release preparation."""
 
+    print(
+        "The release script will increase the version number, "
+        "create a changelog and create a release branch. Let's go!"
+    )
+
     ensure_clean_git()
     version = next_version(args)
     confirm_version(version)
@@ -202,8 +215,10 @@ def main(args: argparse.Namespace) -> None:
     generate_changelog(version)
     base = git_current_branch()
     branch = create_release_branch(version)
+
     create_commit(version)
     push_changes()
+
     print_done_message(branch, base, version)