Buck: buck build

buck build

Builds one or more specified targets.

As Buck is a build system, this is the most commonly used command in Buck. To build a rule, pass its target to buck build:

buck build //java/com/example/app:amazing

Note that any remote_file rules referenced by your build rules must be downloaded with buck fetch prior to calling this command if you don't set in_build = true in the [download] section of your .buckconfig.

Parameters

  • --build-report Specifies a file where a JSON summary of the build output should be written. Note that --build-report can be used without --keep-going, though if --keep-going is not specified, the report will only be written if all of the targets are built successfully. Here is a sample build report:

    {
      "success": false,
      "results": {
        "//fake:rule1": {
          "success": true,
          "type": "BUILT_LOCALLY",
          "output": "buck-out/gen/fake/rule1.txt"
        },
        "//fake:rule2": {
          "success": false
        },
        "//fake:rule3": {
          "success": true,
          "type": "FETCHED_FROM_CACHE"
        }
      }
    }
    

    In this example, both //fake:rule1 and //fake:rule3 were built successfully, but only //fake:rule1 had an output file associated with the rule.

    Note that this contains the same information that --keep-going prints to the console, but is easier to parse programmatically. This report may contain more fields in the future.

  • --keep-going When specified, Buck will attempt to build all targets specified on the command line, even if some of the targets fail. (Buck's default behavior is to exit immediately when any of the specified targets fail.)

    When --keep-going is specified, a report of the build will be printed to stderr, detailing the build status of each target. Each line of the report represents the status of one build target, which has up to four columns:

    1. OK or FAIL, as per the success of the build rule.
    2. The build target of the rule.
    3. If successful, the type of the success as defined by the com.facebook.buck.rules.BuildRuleSuccess.Type enum.
    4. If successful, the path to the output file of the rule, if it exists.
    For example, if Buck were run with the following arguments:

    buck build --keep-going //fake:rule1 //fake:rule2 //fake:rule3

    Then the report printed to stderr might look like:

    OK   //fake:rule1 BUILT_LOCALLY buck-out/gen/fake/rule1.txt
    FAIL //fake:rule2
    OK   //fake:rule3 FETCHED_FROM_CACHE
    

    In this example, both //fake:rule1 and //fake:rule3 were built successfully, but only //fake:rule1 had an output file associated with the rule. Admittedly, the state of column 1 could be derived from the presence of column 3, but the encoding of column 1 makes it easier to filter out successful rules from failed ones.

    Note that when --keep-going is specified, the exit code will be 0 only if all targets were built successfully.

    This option is analogous to -k/--keep-going in Make.

  • --out Takes the output of the build target and copies it to the specified path. Only works with a single build target, and the corresponding build rule must support this option.
  • --populate-cache Performs a cache population, which makes the output of all unchanged transitive dependencies available (if these outputs are available in the remote cache). Does not build changed or unavailable dependencies locally.
  • --verbose (-v) How verbose logging to the console should be, with 1 as the minimum and 10 as the most verbose.