doc/travis-ci.md

   1 Travis CI
   2 =========
   3
   4 Support for using travis-ci has been added in order to automate pull-testing.
   5 See [travis-ci.org](https://travis-ci.org/) for more info
   6
   7 This procedure is different than the pull-tester that came before it in a few
   8 ways.
   9
  10 There is nothing to administer. This is a major feature as it means
  11 that builds have no local state. Because there is no ability to login to the
  12 builders to install packages (tools, dependencies, etc), the entire build
  13 procedure must instead be controlled by a declarative script `.travis.yml`.
  14 This script declares each build configuration, creates virtual machines as
  15 necessary, builds, then discards the virtual machines.
  16
  17 A build matrix is constructed to test a wide range of configurations, rather
  18 than a single pass/fail. This helps to catch build failures and logic errors
  19 that present on platforms other than the ones the author has tested. This
  20 matrix is defined in the build script and can be changed at any time.
  21
  22 All builders use the dependency-generator in the [depends dir](/depends), rather than
  23 using apt-get to install build dependencies. This guarantees that the tester
  24 is using the same versions as Gitian, so the build results are nearly identical
  25 to what would be found in a final release. However, this also means that builds
  26 will fail if new dependencies are introduced without being added to the
  27 dependency generator.
  28
  29 In order to avoid rebuilding all dependencies for each build, the binaries are
  30 cached and re-used when possible. Changes in the dependency-generator will
  31 trigger cache-invalidation and rebuilds as necessary.
  32
  33 These caches can be manually removed if necessary. This is one of the very few
  34 manual operations that is possible with Travis, and it can be done by the
  35 Bitcoin Core committer via the Travis web interface.
  36
  37 In some cases, secure strings may be needed for hiding sensitive info such as
  38 private keys or URLs. The travis client may be used to create these strings:
  39 http://docs.travis-ci.com/user/encryption-keys/
  40
  41 For the details of the build descriptor, see the official docs:
  42 http://docs.travis-ci.com/user/build-configuration/