Apply suggestions from code review

Co-Authored-By: Tobias Wochinger <[email protected]>
Dazu-io · Nov 27, 2019 · 203f39d · 203f39d
1 parent 2c12ccd
commit 203f39d
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 10 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -103,7 +103,7 @@ jobs:
     python: 3.6
     if: tag IS present
     env:
-      # GH_RELEASE_NOTES_TOKEN (github tokeb on rasabot account. used to publish releases to GH)
+      # GH_RELEASE_NOTES_TOKEN (github token on `rasabot` account. Used to publish releases to GH.)
       - secure: "dlgHiKPl5Gk0CSZU4ZuNAx+8WqsG/RSYISN0TiiWAq5nHtKxklWfkBiyQqR92bEmh9y4s24yfgM4MHdcYpIfb+ZfDDIi0p7IXt3pZag0fsQGm075e2j4rVZf3MDd+Ybt4MbdBnwgm1u5xqLyuG7mRM8O4fPuPtLh8WH/GCIfSW/vQYUHciBNMIQGkvTicMHhGjDuSvk8dJswo8Fz9dizze2Udk8oIMV46ofGrH3k03fQ6kRsNY0rDLzNViVBPIpeAUNtL63SeBIQHCJe971S2dLCC/J08pa6y9d/qTa3/kqNe05Wpuj/Fm18ARGZTwI0OZg2CeNbb/3W2pup5hh34s+7Dgt3GGokAtV+/RPpuZXZAXkuw7Pnnr3A4GB8T4yprYixrSm/8FebX3Z3kMXJSE8nHaOYKmBfIrQZssbtnM+arq3of3gMGhYSyq+foa8fXSv1flp6PhR+1WycJDk3uN+wvBN+zoU1uQ58txZWXEhcsYD6mI7EVMi/MPJdRKFRr5+zt/sO87OfSx61cW52ZLb2kYaNVyDZ7Oeda35ZwV1cHauH5/SLp+kXMAfkz48aV6vahKO3L/Jd9Xb89iLRPY6Yek6KGFVic0GAe91uW3QAO6qXfjk6/1tdzW9VF1+KDRI7YhDdqbd03LCgJeDFdPOFAuI9bsmnqVQCIIV3eGM="
       addons:
         apt:

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -13,7 +13,7 @@ This project adheres to `Semantic Versioning`_ starting with version 1.0.
 
     You **may** edit previous change logs to fix problems like typo corrections or such.
     You can find more information on how to add a new change log entry at
-    https://github.com/RasaHQ/rasa/tree/master/changelog/
+    https://github.com/RasaHQ/rasa/tree/master/changelog/ .
 
 .. towncrier release notes start
 

diff --git a/README.md b/README.md
@@ -139,10 +139,10 @@ Releasing a new version is quite simple, as the packages are build and distribut
 
 *Release steps*:
 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
+1. Switch to the branch you want to cut the release from (`master` in case of a major / minor, the current feature branch for patch releases) 
+3. Run `make release`
+4. Create a PR against master or the release branch (e.g. `1.2.x`)
+4. 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 "next release"
     git push origin 1.2.0 --tags

diff --git a/changelog/.gitignore b/changelog/.gitignore
@@ -1,2 +1,2 @@
 # Except this file
-!.gitignore
+!.gitignore
diff --git a/scripts/publish_gh_release_notes.py b/scripts/publish_gh_release_notes.py
@@ -1,6 +1,6 @@
 """
 Script used to publish GitHub release notes extracted from CHANGELOG.rst.
-This script is meant to be executed after a successful deployment in Travis.
+This script is executed by Travis after a new release was successfully built.
 
 Uses the following environment variables:
 * TRAVIS_TAG: the name of the tag of the current commit.

diff --git a/scripts/release.py b/scripts/release.py
@@ -38,7 +38,7 @@ def create_argument_parser() -> argparse.ArgumentParser:
 
 def project_root() -> Path:
     """Root directory of the project."""
-    return Path(os.path.dirname(__file__)) / ".."
+    return Path(os.path.dirname(__file__)).parent
 
 
 def version_file_path() -> Path:
@@ -51,7 +51,7 @@ def write_version_file(version: Text) -> None:
 
     with version_file_path().open("w") as f:
         f.write(
-            f"# this file will automatically be changed, \n"
+            f"# this file will automatically be changed,\n"
             f"# do not add anything but the version number here!\n"
             f'__version__ = "{version}"\n'
         )