flashlight-build  

flashlight-build is a gost project that provides repeatable builds and consolidated pull requests for flashlight.

Building Flashlight

Flashlight requires Go 1.4.x.

It is convenient to build flashlight for multiple platforms using gox.

The typical cross-compilation setup doesn't work for anything that uses C code, which includes the DNS resolution code and some other things. See this blog for more discussion.

To deal with that, you need to use a Go installed using gonative. Ultimately, you can put this go wherever you like. Ox keeps his at ~/go_native.

go get github.com/mitchellh/gox
go get github.com/getlantern/gonative
cd ~
gonative build -version="1.4" -platforms="darwin_amd64 linux_386 linux_amd64 windows_386"
mv go go_native

Finally update your GOROOT and PATH to point at ~/go_native instead of your previous go installation. They should look something like this:

➜  flashlight git:(1606) ✗ echo $GOROOT
/Users/ox.to.a.cart//go_native
➜  flashlight git:(1606) ✗ which go
/Users/ox.to.a.cart//go_native/bin/go

Now that you have go and gox set up, the binaries used for Lantern can be built with the ./crosscompile.bash script. This script also sets the version of flashlight to the most recent commit id in git, or if the most recent commit is tagged, the tag of that commit id.

An annotated tag can be added like this:

git tag -a v1.0.0 -m"Tagged 1.0.0"
git push --tags

The script tagandbuild.bash tags and runs crosscompile.bash.

./tagandbuild.bash <tag>

Note - ./crosscompile.bash omits debug symbols to keep the build smaller.

Note also that these binaries should be signed for use in production, at least on OSX and Windows. On OSX the command to do this should resemble the following (assuming you have an associated code signing certificate):

codesign -s "Developer ID Application: Brave New Software Project, Inc" -f install/osx/pt/flashlight/flashlight

The script copyexecutables.bash takes care of signing the OS X executable and copying everything in the Lantern file tree.

copyexecutables.bash will also optionally sign the Windows executable if the environment variables BNS_CERT and BNS_CERT_PASS are set to point to bns-cert.p12 and its password.

The code signing certificate and password can be obtained from too-many-secrets.

note - Signing windows code requires that the osslsigncode utility be installed. On OS X with homebrew, you can do this with brew install osslsigncode.

Updating Icons

The icons used for the system tray are stored in src/github/getlantern/flashlight/icons. To apply changes to the icons, make your updates in the icons folder and then run ./udpateicons.bash.

Continuous Integration with Travis CI

Continuous builds are run on Travis CI. These builds use the .travis.yml configuration. The github.com/getlantern/cf unit tests require an envvars.bash to be populated with credentials for cloudflare. The original envvars.bash is available here. An encrypted version is checked in as envvars.bash.enc, which was encrypted per the instructions here.