Documentation

Author: allanrenucci

.drone.yml

@@ -1,4 +1,5 @@
 pipeline:
+  # TESTS:
   # We run tests in parallel. Tests run in a copy of the working directory to avoid conflict
   test_legacy:
     group: test
@@ -35,8 +36,10 @@ pipeline:
       - cp -R . /tmp/4/ && cd /tmp/4/
       - ./project/scripts/sbt sbt-dotty/scripted
     when:
+      # sbt scripted tests are slow and don't run on PRs
       event: [ push, tag, deployment ]
 
+  # DOCUMENTATION:
   documentation:
     image: lampepfl/dotty:2017-09-05
     commands:
@@ -45,6 +48,8 @@ pipeline:
     when:
       event: push
 
+  # PUBLISHING:
+  # Publishing expect NIGHTLYBUILD or RELEASEBUILD to be set. See dottyVersion in Build.scala
   publish_nightly:
     image: lampepfl/dotty:2017-09-05
     environment:
@@ -84,6 +89,7 @@ pipeline:
       event: deployment
       environment: sbt_release
 
+  # NOTIFICATIONS:
   slack:
     image: plugins/slack
     channel: dotty
@@ -92,5 +98,5 @@ pipeline:
       status: [ success, failure ]
       event: [ push, tag, deployment ]
 
-
+# CI runs only for the master branch (including PRs)
 branches: master

project/scripts/genDocs

@@ -3,7 +3,8 @@
 # Usage:
 # BOT_PASS=<dotty-bot password> ./genDocs
 
-set -e
+set -ex
+
 # set extended glob, needed for rm everything but x
 shopt -s extglob
 

project/scripts/sbt

@@ -3,6 +3,8 @@
 # Usage:
 # ./sbt <cmd>
 
+set -ex
+
 CMD="$1"
 
 if [ -z "$CMD" ]; then
@@ -13,7 +15,7 @@ fi
 # get the ivy2 cache
 ln -s /var/cache/drone/ivy2 "$HOME/.ivy2"
 
-# run sbt with the supplied arg:
+# run sbt with the supplied arg
 sbt -J-Xmx4096m \
     -J-XX:ReservedCodeCacheSize=512m \
     -J-XX:MaxMetaspaceSize=1024m \

project/scripts/sbtPublish

@@ -3,6 +3,8 @@
 # Usage:
 # SONATYPE_USER=<sonatype user> SONATYPE_PW=<sonatype pw> PGP_PW=<pgp pw> ./sbtPublish <publish cmd>
 
+set -ex
+
 # Release command:
 RELEASE_CMD="$1"
 
@@ -30,6 +32,7 @@ CMD="$CMD ;set pgpSecretRing := file(\"/keys/secring.asc\")"
 CMD="$CMD ;set pgpPublicRing := file(\"/keys/pubring.asc\")"
 CMD="$CMD $RELEASE_CMD"
 
+# run sbt with the supplied arg
 sbt -J-Xmx4096m \
     -J-XX:ReservedCodeCacheSize=512m \
     -J-XX:MaxMetaspaceSize=1024m \