OkBuck is a gradle plugin that lets developers utilize the Buck build system on a gradle project.
Java Shell Kotlin Other
Clone or download
Latest commit c683990 Aug 13, 2018
Permalink
Failed to load latest commit information.
.circleci Do not pickup source jars which are not actually zip files (#694) Aug 13, 2018
.idea/codeStyles Add gjf based codestyles May 17, 2018
another-app Format sample projects java code with gjf May 17, 2018
app Remove comments from android manifests during merging (#695) Aug 13, 2018
buildSrc Publish v0.40.1 Aug 13, 2018
config Add GJF code style pre commit hook support (#656) May 16, 2018
dummy-transform Format sample projects java code with gjf May 17, 2018
dummylibrary Format sample projects java code with gjf May 17, 2018
gradle/wrapper Upgrade gradle and AGP (#687) Jun 23, 2018
java-app Format sample projects java code with gjf May 17, 2018
kotlin-app Format sample projects java code with gjf May 17, 2018
libraries Add support for kotlin allopen (#670) May 24, 2018
tooling Add GJF code style pre commit hook support (#656) May 16, 2018
transform-cli Upgrade gradle and AGP (#687) Jun 23, 2018
.buckconfig Fix version removal logic to enable kotlin 1.2.50 upgrade (#684) Jun 16, 2018
.buckjavaargs Cleanup project and dependencies (#243) Nov 13, 2016
.bucklogging.properties Cleanup project and dependencies (#243) Nov 13, 2016
.gitignore Add gjf based codestyles May 17, 2018
.watchmanconfig Fix watchman config default ignores. (#586) Feb 19, 2018
LICENSE Update LICENSE Sep 29, 2016
README-zh.md Publish v0.40.1 Aug 13, 2018
README.md Publish v0.40.1 Aug 13, 2018
Usage.md Fix broken buckconfig link in Usage.md (#582) Jan 31, 2018
buckw fixing skip check bug (#677) May 30, 2018
build.gradle Add support for kotlin allopen (#670) May 24, 2018
dependencies.gradle Upgrade bintray plugin to 1.8.2 Jun 23, 2018
gradlew Bump to gradle 4.0 stable. (#454) Jun 20, 2017
plugin Make plugin able to publish to maven local Sep 27, 2016
settings.gradle Add support for artifact classifiers (#625) Apr 16, 2018

README.md

OkBuck

CircleCI Download

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

Wiki, 中文版

Installation

These are needed to build with buck Installation instructions for: Android NDK, 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.40.1'
    }
}

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.

Code Style

We use google-java-format to format Java files. You can either install the IntelliJ plugin or use a pre commit hook to automatically re-format files.

To add a pre commit hook:

  • Build google-java-format jar following instructions from github page.
  • Copy config/git-hooks/pre-commit.template to .git/hooks/pre-commit
  • Make the script executable: chmod +x .git/hooks/pre-commit
  • Replace <<PATH_TO_JAR>> in .git/hooks/pre-commit with the location of google-java-format jar.

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.