build/README

   1 Prerequisites
   2 =============
   3
   4 In order to build packages, you will need:
   5
   6 * Docker installed
   7 * permission to run Docker commands
   8 * the `WORKSPACE` environment variable set to the absolute path of an
   9   Arvados Git work tree
  10
  11 Quickstart
  12 ==========
  13
  14 Build and test all the packages for debian10 on your architecture by
  15 running:
  16
  17     ./run-build-test-packages-one-target.sh --arch "$(arch)"
  18
  19 This will build package build and test Docker images for debian10, build all
  20 packages in a build container, then test all packages in a test container.
  21
  22 Use a different distro by adding the `--target TARGET` option.
  23
  24 Limit the build to a single package by adding the `--only-build
  25 PACKAGE_NAME` option. This is helpful when a build is mostly in good shape
  26 and you're tracking down last bugs in one or two packages.
  27
  28 Get more verbose output by adding the `--debug` option.
  29
  30 By default the script avoids rebuilding or retesting packages that it
  31 detects have already been done in past runs. You can force the script to
  32 rebuild or retest package(s) with the `--force-build` and `--force-test`
  33 options, respectively.
  34
  35 Run the script with `--help` for more information about other options.
  36
  37 Scripts in this directory
  38 =========================
  39
  40 run-tests.sh                             Run unit and integration test suite.
  41
  42 run-build-test-packages-one-target.sh    Entry point, wraps
  43                                          run-build-packages-one-target.sh to
  44                                          perform package building and testing
  45                                          inside Docker.
  46
  47 run-build-packages-one-target.sh         Build packages for one target inside Docker.
  48
  49 run-build-packages-all-targets.sh        Run run-build-packages-one-target.sh
  50                                          for every target.
  51
  52 run-build-packages.sh                    Actually build packages.  Intended to run
  53                                          inside Docker container with proper
  54                                          build environment.
  55
  56 run-build-packages-python-and-ruby.sh    Build Python and Ruby packages suitable
  57                                          for upload to PyPi and Rubygems.
  58
  59 run-build-docker-images.sh               Build arvbox Docker images.
  60
  61 run-build-docker-jobs-image.sh           Build arvados/jobs Docker image
  62                                          (uses published debian packages)
  63
  64 build-dev-docker-jobs-image.sh           Build developer arvados/jobs Docker image
  65                                          (uses local git tree)
  66
  67 run-library.sh                           A library of functions shared by the
  68                                          various scripts in this
  69                                          directory.