Comment on release script

1 files changed, 5 insertions, 0 deletions

diff --git a/scripts/release.sh b/scripts/release.sh
index 95cfd8f..7f1f1d0 100755
--- a/scripts/release.sh
+++ b/scripts/release.sh
@@ -1,9 +1,14 @@
 yarn test || exit 1
 branchName=$(git symbolic-ref HEAD | sed -e 's,.*/\(.*\),\1,')
 echo $branchName
+# TODO find a better way to exlcude
+# docs from the stash
 git stash push -- src || exit 1
 git checkout master
 yarn run build || exit 1
+# this is a hack required
+# to serve paths that start
+# with '_'
 touch docs/.nojekyll
 git add docs
 git commit -m "Update docs for release $1"