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
  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 architecture by adding the `--arch ARCH`
  25 option. Supported architectures are amd64 and arm64. Note cross-compilation
  26 from amd64 to arm64 is currently only supported on Debian 11+.
  27
  28 Limit the build to a single package by adding the `--only-build
  29 PACKAGE_NAME` option. This is helpful when a build is mostly in good shape
  30 and you're tracking down last bugs in one or two packages.
  31
  32 Get more verbose output by adding the `--debug` option.
  33
  34 By default the script avoids rebuilding or retesting packages that it
  35 detects have already been done in past runs. You can force the script to
  36 rebuild or retest package(s) with the `--force-build` and `--force-test`
  37 options, respectively.
  38
  39 Run the script with `--help` for more information about other options.
  40
  41 Scripts in this directory
  42 =========================
  43
  44 run-tests.sh                             Run unit and integration test suite.
  45
  46 run-build-test-packages-one-target.sh    Entry point, wraps
  47                                          run-build-packages-one-target.sh to
  48                                          perform package building and testing
  49                                          inside Docker.
  50
  51 run-build-packages-one-target.sh         Build packages for one target inside Docker.
  52
  53 run-build-packages-all-targets.sh        Run run-build-packages-one-target.sh
  54                                          for every target.
  55
  56 run-build-packages.sh                    Actually build packages.  Intended to run
  57                                          inside Docker container with proper
  58                                          build environment.
  59
  60 run-build-packages-python-and-ruby.sh    Build Python and Ruby packages suitable
  61                                          for upload to PyPi and Rubygems.
  62
  63 run-build-docker-images.sh               Build arvbox Docker images.
  64
  65 run-build-docker-jobs-image.sh           Build arvados/jobs Docker image
  66                                          (uses published debian packages)
  67
  68 build-dev-docker-jobs-image.sh           Build developer arvados/jobs Docker image
  69                                          (uses local git tree)
  70
  71 run-library.sh                           A library of functions shared by the
  72                                          various scripts in this
  73                                          directory.
  74
  75 Adding a new target
  76 ===================
  77
  78 In order to build packages on a new distribution, you MUST:
  79
  80 * Add a rule for `TARGET/generated` to `package-build-dockerfiles/Makefile`.
  81 * Add the new `TARGET/generated` rule to the `all` target in
  82   `package-build-dockerfiles/Makefile`.
  83 * Write `package-build-dockerfiles/TARGET/Dockerfile`.
  84 * Add a rule for `TARGET/generated` to `package-test-dockerfiles/Makefile`.
  85 * Add the new `TARGET/generated` rule to the `all` target in
  86   `package-test-dockerfiles/Makefile`.
  87 * Write `package-test-dockerfiles/TARGET/Dockerfile`.
  88 * Create `package-testing/test-packages-TARGET.sh`, ideally by making it a
  89   symlink to `FORMAT-common-test-packages.sh`.
  90
  91 Of course, any part of our package build or test infrastructure may need to
  92 be updated to accommodate the process for new distributions. If you're
  93 having trouble building lots of packages, consider grepping these build
  94 scripts for the identifier of the closest working target, and see if you may
  95 need to add branches or similar hooks for your target. If you're having
  96 trouble building specific packages, consider doing the same for those
  97 packages' `fpm-info.sh` files.