OkBuck is a gradle plugin that lets developers utilize the Buck build system on a gradle project.
Groovy Java Shell
Latest commit 61ea271 Jan 19, 2017 @kageiit kageiit committed on GitHub Create aidl rules per source directory (#341)
Permalink
Failed to load latest commit information.
another-app Android Lint Support (#228) Nov 6, 2016
app Ensure AutoValue compiles in gradle builds for app project (#311) Jan 5, 2017
buildSrc Create aidl rules per source directory (#341) Jan 20, 2017
config Android Lint Support (#228) Nov 6, 2016
dummylibrary Break apart provided and apt scopes (#315) Jan 7, 2017
gradle/wrapper Update gradle and android gradle plugin versions (#321) Jan 11, 2017
libraries Build updates (#298) Dec 22, 2016
tools Better groovy support (#299) Dec 22, 2016
.buckconfig Build updates (#298) Dec 22, 2016
.buckjavaargs Cleanup project and dependencies (#243) Nov 13, 2016
.bucklogging.properties Cleanup project and dependencies (#243) Nov 13, 2016
.buckversion Build updates (#298) Dec 22, 2016
.gitignore Cleanup Documentation Sep 27, 2016
.travis.yml Build updates (#298) Dec 22, 2016
.watchmanconfig Create default configuration files when running the wrapper task Sep 27, 2016
CHANGELOG.md Change project structure and package names to uber Sep 29, 2016
LICENSE Update LICENSE Sep 29, 2016
README-zh.md Publish v0.14.4 Jan 19, 2017
README.md Publish v0.14.4 Jan 19, 2017
Usage.md Move extensions and tasks into java 8 (#331) Jan 14, 2017
buckw Move extensions and tasks into java 8 (#331) Jan 14, 2017
build.gradle Move extensions and tasks into java 8 (#331) Jan 14, 2017
dependencies.gradle Update gradle and android gradle plugin versions (#321) Jan 11, 2017
gradlew Update versions (#261) Dec 3, 2016
plugin Make plugin able to publish to maven local Sep 27, 2016
settings.gradle Groovy Support (#263) Dec 5, 2016

README.md

OkBuck

Master branch build status Download

OkBuck is a gradle plugin that lets developers utilize the Buck build system on a gradle project.

Wiki, 中文版

Installation

Mac OS X

brew update

# Required to build and use buck
brew install android-ndk ant

# Optional, but recommended for faster development
brew install watchman

Linux

Installation instructions for: Android NDK, Ant, Watchman

Configuration

Set the ANDROID_NDK environment variable to point to your android ndk installation

In root project build.gradle file:

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.uber:okbuck:0.14.4'
    }
}

repositories {
    jcenter()
}

apply plugin: 'com.uber.okbuck'

After applying the plugin, the following tasks will be added to the root project

  • buckWrapper will create a buck wrapper script and various configuration files to invoke buck commands
  • okbuck will generate BUCK files

Buck Wrapper

Run the buck wrapper task

./gradlew :buckWrapper

This creates a buckw wrapper similar to the gradle wrapper

Invoking buck commands via the buck wrapper has several advantages

  • Downloads/installs/updates buck
  • Minimal overhead to decide when to run okbuck before invoking buck (using watchman)
  • Handles gracefully, the cases when okbuck task fails/is stopped abruptly

Please make sure you have watchman installed for buckw to run okbuck only when needed. A new okbuck run is typically needed when gradle configuration or Android manifest files change. If watchman is not installed, the okbuck task in always run before invoking any buck commands.

Usage

# List all buck targets
./buckw targets

# Build a target
./buckw build <target>

# Install an apk target
./buckw install --run <apk-target>

# Generate an Intellij project
./buckw project

See the Usage page for complete details on how to configure OkBuck and Buck.

Buck Http Cache

To speed up your builds even more, you can use an implementation of Buck's HTTP Cache API to take advantage of building once and using the same build artifacts on all machines.

Contributors

We'd love for you to contribute to our open source projects. Before we can accept your contributions, we kindly ask you to sign our Uber Contributor License Agreement.

  • If you find a bug, open an issue or submit a fix via a pull request.
  • If you have a feature request, open an issue or submit an implementation via a pull request
  • If you want to contribute, submit a pull request.

License

Copyright (c) 2016 Uber Technologies, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.