From b57119dff246336787be739d116d7df31a3c4833 Mon Sep 17 00:00:00 2001
From: Enes Aldemir <aldemirenes@live.com>
Date: Fri, 16 Aug 2019 14:04:14 +0300
Subject: [PATCH] Integrate sbt-gh-pages to create GH Pages from Scaladoc
 (closes #91)

---
 .travis.yml                    |   1 +
 .travis/deploy.sh              |   1 +
 .travis/deploy_docs.sh         |  17 +++++++++++++++++
 build.sbt                      |   4 ++++
 project/BuildSettings.scala    |  18 ++++++++++++++++++
 project/plugins.sbt            |   5 ++++-
 project/travis-deploy-key.enc  | Bin 0 -> 3392 bytes
 src/site-preprocess/index.html |  20 ++++++++++++++++++++
 8 files changed, 65 insertions(+), 1 deletion(-)
 create mode 100755 .travis/deploy_docs.sh
 create mode 100644 project/travis-deploy-key.enc
 create mode 100644 src/site-preprocess/index.html

diff --git a/.travis.yml b/.travis.yml
index 38fe6f1..76d4d87 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -23,3 +23,4 @@ env:
   # SONA_PASS
   - secure: oDu2dXzektYr/7K5nw7EL2qDUR5AhO4Uz6XGHoOQsN1gJiovdsa5nJeDHgo2YFGpJljyTo+lABbxpGIFQpcnKGIG9eAaXIyYpRlEiksTUnZdwIlCXkRMg2l9cUr30ZDOoVS8QpQbCDdogOSqJ+RUShSuiXR8Qi2e0RfrsVucgkNogQ6w1IoB9kV8CAYsnJVzi/oenTJZjEh5qrKiUALpkiHGjB9WSIHQ80sAO/rwnr88w++HcOIqgnvhJ3/Ig3N6201Slud5pF2yVz4MxzY8bedetqNil5ffosYiU7dladOiKTVj8efZPx0cGq0dhpAZFVhehlXyu4EA24NRgKYvAIc0xWVVm49IBaMpDDI/nh24uF9fBPt2+Apj5BY/ETpKS5tFqFaGkBjlL9KFL3l2DfnWC8AfTHlBXFlkH8tKPSN4so612QAmWuULtrVuQpV8DF40HNwJoR2Lyyy5aHrZtpdjHsp3OJI83QfCxH2yTYhes4eHAxi4ynZDSDolt6mrjx651mmlQCsJWJ5KdWHQwjqzgRP8q1/bCaDYdODhrz0K1JPl6YYA+dzwRP+rFeSQbzG0yGo12p7FZGpq36/Hq9C/HSw6WVDN3Lr8CUxZr1rDhtmAvaMJG5EyYDXpNGn9j2DJX76A1Ifu7KXCp8h+FTLPa1CIxJruNxEA6vFSdqA=
   - SONA_USER=snowplow
+  - ENCRYPTION_LABEL: <placeholder>
diff --git a/.travis/deploy.sh b/.travis/deploy.sh
index 05b06fe..884d020 100755
--- a/.travis/deploy.sh
+++ b/.travis/deploy.sh
@@ -18,6 +18,7 @@ pwd
 
 project_version=$(sbt version -Dsbt.log.noformat=true | perl -ne 'print $1 if /(\d+\.\d+\.\d+[^\r\n]*)/')
 if [ "${project_version}" == "${tag_version}" ]; then
+    ./.travis/deploy_docs.sh
     sbt +publish
     sbt +bintraySyncMavenCentral
 else
diff --git a/.travis/deploy_docs.sh b/.travis/deploy_docs.sh
new file mode 100755
index 0000000..164d44b
--- /dev/null
+++ b/.travis/deploy_docs.sh
@@ -0,0 +1,17 @@
+#!/bin/bash
+
+ENCRYPTED_KEY_VAR="encrypted_${ENCRYPTION_LABEL}_key"
+ENCRYPTED_IV_VAR="encrypted_${ENCRYPTION_LABEL}_iv"
+ENCRYPTED_KEY=${!ENCRYPTED_KEY_VAR}
+ENCRYPTED_IV=${!ENCRYPTED_IV_VAR}
+
+git config --global user.name "$USER"
+git config --global user.email "$TRAVIS_BUILD_NUMBER@$TRAVIS_COMMIT"
+
+openssl aes-256-cbc -K $ENCRYPTED_KEY -iv $ENCRYPTED_IV -in project/travis-deploy-key.enc -out project/travis-deploy-key -d
+chmod 600 project/travis-deploy-key
+
+eval "$(ssh-agent -s)"
+ssh-add project/travis-deploy-key
+
+sbt ghpagesPushSite
diff --git a/build.sbt b/build.sbt
index bd4aeec..1ed9a31 100644
--- a/build.sbt
+++ b/build.sbt
@@ -20,10 +20,14 @@ lazy val root = project.in(file("."))
     scalaVersion       := "2.12.8",
     crossScalaVersions := Seq("2.11.12", "2.12.8")
   ))
+  .enablePlugins(SiteScaladocPlugin)
+  .enablePlugins(GhpagesPlugin)
+  .enablePlugins(PreprocessPlugin)
   .settings(BuildSettings.buildSettings)
   .settings(BuildSettings.publishSettings)
   .settings(BuildSettings.mimaSettings)
   .settings(BuildSettings.scoverageSettings)
+  .settings(BuildSettings.ghPagesSettings)
   .settings(Seq(
     shellPrompt := { _ => name.value + " > " }
   ))
diff --git a/project/BuildSettings.scala b/project/BuildSettings.scala
index 4c7d071..914fc29 100644
--- a/project/BuildSettings.scala
+++ b/project/BuildSettings.scala
@@ -26,6 +26,12 @@ import com.typesafe.tools.mima.plugin.MimaPlugin
 // Scoverage plugin
 import scoverage.ScoverageKeys._
 
+import com.typesafe.sbt.sbtghpages.GhpagesPlugin.autoImport._
+import com.typesafe.sbt.site.SitePlugin.autoImport._
+import com.typesafe.sbt.site.SiteScaladocPlugin.autoImport._
+import com.typesafe.sbt.SbtGit.GitKeys.{gitBranch, gitRemoteRepo}
+import com.typesafe.sbt.site.preprocess.PreprocessPlugin.autoImport._
+
 object BuildSettings {
 
   // Basic settings for our app
@@ -91,4 +97,16 @@ object BuildSettings {
       (coverageReport dependsOn (test in Test)).value
     }
   )
+
+  val ghPagesSettings = Seq(
+    ghpagesPushSite := (ghpagesPushSite dependsOn makeSite).value,
+    ghpagesNoJekyll := false,
+    gitRemoteRepo := "git@github.com:snowplow/snowplow-scala-analytics-sdk.git",
+    gitBranch := Some("gh-pages"),
+    siteSubdirName in SiteScaladoc := s"${version.value}",
+    preprocessVars in Preprocess := Map("VERSION" -> version.value),
+    excludeFilter in ghpagesCleanSite := new FileFilter {
+      def accept(f: File) = true
+    }
+  )
 }
diff --git a/project/plugins.sbt b/project/plugins.sbt
index 5888fe2..3db8a8c 100644
--- a/project/plugins.sbt
+++ b/project/plugins.sbt
@@ -1,3 +1,6 @@
 addSbtPlugin("org.foundweekends" % "sbt-bintray" % "0.5.3")
 addSbtPlugin("com.typesafe" % "sbt-mima-plugin" % "0.5.0")
-addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.6.0")
\ No newline at end of file
+addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.6.0")
+addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.4.0")
+addSbtPlugin("com.typesafe.sbt" % "sbt-git" % "1.0.0")
+addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.6.3")
diff --git a/project/travis-deploy-key.enc b/project/travis-deploy-key.enc
new file mode 100644
index 0000000000000000000000000000000000000000..eed0d2caccf4bf61c3334644fd386a6d6d7be63d
GIT binary patch
literal 3392
zcmV-G4Zrd^K71EP&x&X82{Y_u!&G#1I`iMLx>|DqKu}<vi86OLfEnYz*Oj%Q-PT>2
z%n0xZl!KI4^+r%&pUI5&CQ3jSy<?fmP0ixKUmI}@{P8E1<cub%b5hxw4#VV?(^Zj1
zgRiSVVV61chLh6Mv}uty+7RYuJmZ@izxm#_;A<L#pwt{wVk=IvWH=G>E3(jfAwZ#a
zuEe69dWg1ERljV4olFZZyyxe(9{8w*&Wa%67h*B|OAj^$!H1VXY|5{Dn0ovo(@oPx
z|3Bg|I>4~~{f10cM4*8j6fC8wRWAADwVDMJ83GKHJ)^%NCt<}n6uxjt>FE>mr~4`d
z0s-QneRfS|Za$DU=WW~S0n7~s78Ib#vKrf*Y>s(j^ps#?^8ax_n<kaUqEbI_!V(<S
zf`6Bxu>-?R#+ijDm^$MZL0D~XC;5SHc=Su3M<R+scxHRTc7Ajk@Eo5yOg?2!6BF7V
ztFlF$cVp+rE|)Kmj^jXV?ZKUj7y|ba__^+~XYOcPY1+6}U<M)r#7_bF9N~tOD`fSC
zlP=Z%TJHqzH_}ThGc4A3qI-URKT2T<y}=BvAQ)`J`ZKwkX3}zAu)_oBi*cR=wkYMc
zEa{p)lJi*C$Kj&+N{pHOl6Gyb62I}{tm3aH$a>-)o2`_s83u@AW#=tR>0F5V;RImF
z>0nMB^?{1{1oxitG;h-pI!q++0~;~%#y2exd^Yhmq&xdP$5I<082Q2GP1|q-;ufMQ
zKT|4aD9Q2cp}?G|MhJI%U|Vgj0;~SnH3H5LrDlN!vLWR>L8|~_r2-#Yv50d9%1G;D
zz#|Kw>vfjmbbMxVkkVOxqKC#(l|QzU6tCDDp)scug5Ad>&|aQc*==Qv9Z7GYo$TrZ
zmltn4k&dN~taE^;qj=x$NIA-cHb8mMMHJ<nv?KfEJq%BwLLEC0mn+qDmwR0^9OwUc
z@6zyuk(5UXB1|LS2Viq;s~!T__{UKi5B9AdKfcwm;Ve5aXl)sEIb%XDdZB^Cc9ZwJ
zS2aMJyHSQ~zruJn<OiGS@Hes;=iSTK)P|Zn>^@AE5uVp2A7M`b(t%iNRa`$q9Q=Oh
zP+?Kv@C(u?21M>2(M?w5A@v_wTz7M)J<x^ZtXHNyWOH3sm1Him8RfCG&NiuwAYRq&
zZk&!=BDo19WvT9oo`J#KK)M1|4UIbIS4!qB%lxEpO}Nd)^3**Qp3<=DC*%S<f9lKn
zA0tJ;^a4De_VzMp9rlE25?iNtq_{pvS=Q2TUwpYGo>J_T!?uL~?;+ES>wzL|pOZfr
zyp&bYG9&ohv;^-=*>^rxaCV{}@~-x)wQalFIYq(DHvgjLONd7HIHqU%Q1w(5Hl{}F
z$|=!^(U4QmDN`gWa$qW+HHSzQfx0qUf^SHc<o?k%sICS&jNj)%yJ#nY;odvG8PBL=
zIE97Yb{{6+vBY*>VKG=<w{+;k_YREB!1UO}1)Yi13flnS+y5tzAlCf2$qHvG#%TmW
zQz;(7I~ZjyXU9ox59gltXJ|+J;j=X-Y<12Y4M*Kbgrv<KcQ{b<+#|4BtyqMV-8a6e
z2)0!OAz<76RT0gVMsM0Lv$@K2=iG2)*17BO58f(HsKdq6WsK{WC<&nk*F`Z|(51u@
zMk!^gMp}J!ERq9P<yAEgUQG}~{!2XDqyLuEP*hH5!Mn&RGxdu>pOUa*867eYtSe_w
z<><&*BBLn|Pi?B;(%<B%-VOHs(pz3F`T#sDYr_;!MCWqo(p?FJCuH|5WA=&J*YF&H
zdCueDNn-1)rv>OHWb%kYX@AB$W+XRv?tQMO-A~*xsOPjqw!$&jL9S7=P!2el^_gg_
z+=?e?CRTt~ni>Xmq$^`sZwu&`Nw{Cu5~26E212U#T*MM+YxFDaEiDxt=dG8vLn}dp
zw3j4p1D_Sx)xuhlyUZ4^zUB=M?`7;X7t$v(&he=4R{AJ)c;E<1zlsjWjt7DcI++a$
zPRI#IQ7QO_37BVs?`XXTSi5vYTP=eTuMY@fxNJd8B?FpIaSs}2CwKl>qx2<2T49IR
zD;<tAsL$~i!sFeo*?ZPy{coUdFn5P>Y;{Pw>K1Trp(AwOfKN>U`%bmq2>L?X>n-5~
z?lY-lp<9~Fck=3M55p{cL)^sLHNo1F+3Aacb=?W!$rNDDs0JPue$ZG)t)<*v0haZu
zgpQ91kyNt*?^#zHK=BwSw*L1$r74AH%7S07nN4o=?WrEuhJaiKm0o-}x@Q!*hx@fM
zNKH5zzmEcpyq4rLR9|&AQae6&VI2PMFWp4~V-oFE&9oR@06|a1<4qpUjIP2eeia@7
z`?||b1!qWRMdT8)w_2QKpXZk()tV*g-&Dq{MII&!YF^=TGQUm%OW-4y(dS8QS>RAE
zt)t-kVl8?n#3RWsIYY4=3@bNqqUsjehfqDJNPkz1ZT;%THmwp*7b!;;M;;e+lbasb
z8IO<N=2#nITSLPAWvz(chemyb|8V|O(trxb5xrq$BQVi>)s05>yXXqyfU}71!c)S;
z6Ss3Gap#rxIE_soSy--Ru^18MFkNoA?6XnZty7Ud7!Xx^UC=H%uOcr?&_GiQZy1mZ
zt@O`oNGnK$)Ke1RNZJY%THMfgA+@e!4dL9N5<n)l{7CK7$F)hsQ0)J+_onsZud^hm
z)^nS`$d5=SZCG!)sQ%-T{WIE?10fnZ-V%#y11y6Ifs#p&uyvSoB=`iAB0_?+7J52H
zn@~RN&bhn#K*;2dTZm1L+Kx}y2(P<4ahM<LhQCj?opeyag$S^?hJ)q5{;DT=F!8S;
z)7?54NnJhY!vHL?AJ|D*!_4^Tt$A=Bgkf-io|r`?j<83?4gXK3NpR)4go|L*k%O7(
zZr*OH$trL=tFDUAK14IP0JNtvK3YTVNQlhyEMVglfwsxdAu6eRi?B{|mo}tW;e?|D
z`XiDUNHqiiKaVPGO1kNv;E01}>n#6*4iew~KKWYiMa3H7!QOFYA2-EPR<AXAMNT{$
z!&`R&dQPRYshP{rOORqGBHK`{80s<@>)61i2z!)W5pcgSeIz(5#C*ha_=#FnnyJ4B
zku|^}QRzZH@Q~^_FdbWu=1zd=CO5mlN9*w^AZ=HW+VN7+mp5y;+&$HCwdwrpN|~)2
zq^LY^@{I1?x3L~LqluXR9;@M{VbX76cf_gfonJ>1%8Uxpm@oy#<+iPjL8wCuaX69{
z9Fe@CQ(Ws=)3Ld6$~jaE(ArXw(!%I>g&W8gDm+)utQu%^{)U22P>+AjJXmUtt66&a
z(_7=vd}tUu9gbSS4jQvdxKe~5wmg@TM1SG(j(Mb-?AV|X%K+t3gVz<b0*lgTS57*p
zp|RBt|1D>sfYe0;p7c)qG{58T=KP`BGx_u0U~E5PEp_~<Z#}|%;MYNuV0q|c@6Mwl
zj`r6giwO_p3noo@g!r=~PE>ZVT_*>*{Z_jS0mBNBs?Kpl2nIR!1O`7p41yR~XbF`l
z<)T-CvA@RmXk<l`+#t7{Mgd3-wBM<tXhjVaE`T^9?m6pZLzxdo8${M73Eb&8<+7$c
zVKFZ@LQ+ci^`p2Qrjicz$G9a1nRQ9;&<P=glZK3-i`aYERnd9OW(LtO7#iLx`Fk3s
z3Y1lf`MOdD=R^!&T0jg#vFNQO_CI3))6ZL-hFvyQ*b@5>Wz$w&=E-~&u(o$2mfR^|
zdYzB>xIaxV{+IqG2E-(l4vQ_-0=t%V8lg^UHnP&E`+hRabcR?tIxTh`w*I|L)3bVg
z%stex{-*XNw;X+#d^PIY&62#7!>^9f4A|1xcau;gJRZ+&G)6S;AmgsE*m%gThg2t*
zhmD@ONMoqAeX3HA_rwJow@M#ch>Yc2vPL#!G97Iv%Jo^}8$kJ&bFYygh0!`2UQ`p0
z@lQ~FLvEl|NEFQZ7`+ZLH=|35vo?ZM%$!c5idS=pfQ?{%S$vGgex5POfPOtTARmjZ
z##j+wn2JLa$J>-cXr>{HLI%SCf0g~-Q(xhFZVzr#HT7w%G{Cl$PwLJX_;C?+&~Q#Y
zL~Fp+1A!P&=UhgjSQD1S@)G!w<Rg2cQUvDS>KN)?#FDfV$a4sn4t}^JEKhL#)9*Vz
z{W$W^0ZAXKT$@ciLGG8{Q~m5O66|ngLYtkO8XhKMIQlA7G1HxEc8%cAuD6uhr|aoG
z*Kf2vKI>?V(b$6xUL0Qhd9}XR$~UI<tWxHGoQiA#vg3C}5G#&-;;Qo9KtN|@_wEA$
z=7^Wc5bf^R=a7e;it3aAJ(3OiiM0a*#1cKhpu8=?iY+Y559r?4SQ49s7Yu<4ai0mr
zKg4;MAOXDw#(&Ya5R97j8hLKQlOQ}VGRh&=YJrA5sW00{1?T(^nE1^2{fU(6ssNYP
zISPrscdRMt?{GXHlv>R~Ze}L$)sLgjaihz1ZszmbO>feVsB(lYmK|!z7Y?Q4lHosL
W6i)%%ND-L%)XfP<+MMt$WX1J<Ba;LG

literal 0
HcmV?d00001

diff --git a/src/site-preprocess/index.html b/src/site-preprocess/index.html
new file mode 100644
index 0000000..66e62a4
--- /dev/null
+++ b/src/site-preprocess/index.html
@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Project Documentation</title>
+    <script language="JavaScript">
+    <!--
+    function doRedirect()
+    {
+        window.location.replace("@VERSION@");
+    }
+    doRedirect();
+    //-->
+    </script>
+</head>
+<body>
+<a href="@VERSION@">Go to the project documentation
+</a>
+</body>
+</html>