OkBuck is a gradle plugin, aiming to help developers utilize the super fast build system: BUCK, based on the existing project with Android Studio + gradle, and keep both build systems work, with less to only 10 lines of configuration.
Android Studio + Gradle has already been many Android developers' option, and to migrate to buck, there are many works to be done, which are difficult and buggy. OkBuck aims to provide a gradle plugin, which will do these buggy job for you automaticlly after several lines configuration.
Further more, you can still use OkBuck to maintain your BUCK build system when your gradle configurations changes, OkBuck let you even needn't write one line of the magic BUCK script!
- Generate
.buckconfig. - Copy third-party libraries' jar/aar files to your rootProject directory.
- Generate
BUCKfile for third-party libraries and each sub modules. - After you run
./gradlew okbuckin your rootProject root directory, you can runbuck install app(suppose your application module namesappand you have already installed BUCK).
-
Add this lines into buildscript dependencies part of root rootProject build.gradle (the latest version is displayed on the download badge above):
classpath "com.github.piasy:okbuck-gradle-plugin:${latest version}" -
Add this line into root rootProject build.gradle:
apply plugin: 'com.github.piasy.okbuck-gradle-plugin'
-
Add this
okbuckblock into root rootProject build.gradle:okbuck { target "android-23" overwrite true resPackages = [ 'dummylibrary': 'com.github.piasy.okbuck.example.dummylibrary', 'app': 'com.github.piasy.okbuck.example', ] }
-
Run
./gradlew okbuckand then runbuck install app, enjoy your life with BUCK.
android-23works equally withcompileSdkVersion 23.overwriteis used to control whether overwrite existing buck files;- OkBuck will extract signing config defined in your build.gradle, and the generated BUCK signing configs is put under
/.okbuck/keystorefolder. - You needn't do anything if you have already set only one signing config in your build.gradle, but note that there is a default signing config named
debuggenerated by android gradle plugin. - But you need to configure git to ignore your signing secrete, add this line to your root rootProject .gitignore file:
```
.okbuck/keystore
```
- If you defined multiple signing configs (including the default
debugone), or you want to put OkBuck's generated signing config in another folder which must be under your root rootProject folder, you can set it like below,keystoreDiris used to set the path OkBuck to put your generated signing config (relative to your root rootProject folder, no prefix/), andsignConfigNameis to set the name of the signing config you want to use.
```gradle
okbuck {
target "android-23"
keystoreDir ".okbuck/keystore"
signConfigName "release"
overwrite true
resPackages = [
'dummylibrary': 'com.github.piasy.okbuck.example.dummylibrary',
'app': 'com.github.piasy.okbuck.example',
]
}
```
-
But also remember to configure git to ignore your signing secrete.
-
Full example could be found in the app module of this repo, root rootProject build.gradle, app module build.gradle.
-
resPackagesis used to set Android library module and Android Application module's package name for generated resources (Rin common cases), you need substitute dummylibrary/app with your own module name, and set the corresponding package name inside the single quote, which should be the same package name specified in the corresponding module'sAndroidManifest.xml. -
There are 4 tasks added into your gradle project after apply OkBuck,
okbuck,okbuckDebug,okbuckRelease, andokbuckClean.okbuckCleanwill delete all files generated by OkBuck.okbuckis the shortcut forokbuckRelease.okbuckDebugandokbuckReleasewill make yourdebugCompileandreleaseCompiledependencies visible in buck's build, including annotation processor.
OkBuck can only generate BUCK configs for you, so if your source code is incompatible with BUCK, you need do more jobs.
Read more on Known caveats wiki page.
Maybe there are more caveats waiting for you, but for the super fast build brought by buck, it's worthwhile.
The rest modules in this repo is a full example usage of OkBuck.
If you come with bugs of OkBuck, please open an issue, and it's really appreciated to post the output of ./gradle okbuck --stacktrace at the same time.
Contributions are welcome! See the detail todo list.
If you want to help improve OkBuck, please comment on the corresponding issue, with your expected fix due date, I'll pull you in and assign it to you, and push you.
- Thanks for Facebook open source buck build system.
- Thanks for the discussion and help from promeG during my development.
| User | Repo |
|---|---|
| Piasy | AndroidTDDBootStrap |
If you are using OkBuck in your open source project, send me a e-mail with your repo url, I'll add your repo in this list.
- 0.3.0:
- fix #15 again.
- better dependency process, partly fix Known caveats: handle dependency conflict
- refactor round 2, ready for your contributions!
- 0.2.7:
- fix overwrite doesn't work bug
- fix bug when Android library module doesn't have res dir
- .buckconfig will ignore .svn dirs
- fix #6 again...
- 0.2.6: fix #14
- 0.2.5: fix #15
- 0.2.4: fix #12
- 0.2.3: fix #11
- 0.2.2: fix #6
- v0.2.1
- v0.1.0
- v0.0.1