Awesome

gradle-publish

Introduction

This project includes some gradle scripts that can publish gradle project to JCenter.

bintray.gradle: A script to publish an android gradle project to JCenter.

build.gradle: A demo about how to use it.

gradle.properties: The properties that will be used in bintray.gradle. You are needed to copy this file into your library project and configure the values of these properties.

How To Use

1. Save bintray user and API Key infos

First, you should have one bintray account,(bintray.com) and need save the account user name and API Key info to your .gradle folder. If you havent change the GRADLE_USER_HOME position, it will be under your User folder. In this folder, add the follow infos to gradle.properties file, create it if it doesn`t exist.

BINTRAY_USER=bintray account name
BINTRAY_KEY=bintray API Key

If your OS is Windows, then, the path will be C:\Documents and Settings\YourName\.gradle for XP, and C:\Users\YourName\.gradle for WIN7+.

2. modify `build.gradle` in your library module

Add the dependencies section into build.gradle in your library if it doesn't already exist:

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
        classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.6'
    }
}

Note: The Gradle version I use is 2.14.1. For the other version, you may need to upgrade or downgrade the android-maven-gradle-plugin or gradle-bintray-plugin version.

Then you need download the bintray.gradle into your library project, and add the following to the bottom of your build.gradle file:

apply from: './bintray.gradle'

3. setup `gradle.properties` in your library module

Copy the gradle.properties(which is in this project, not the one we modified in step 1) file to your library module, Click Here to copy it. Then setup it as your needed. Follow is an example,

PROJ_GROUP=com.philcalvin
PROJ_VERSION=1.1.0
PROJ_NAME=iconbutton
PROJ_WEBSITEURL=https://github.com/pnc/IconButton
PROJ_ISSUETRACKERURL=
PROJ_VCSURL=git@github.com:pnc/IconButton.git
PROJ_DESCRIPTION=android icon button
PROJ_ARTIFACTID=com-phillipcalvin-iconbutton

DEVELOPER_ID=pnc
DEVELOPER_NAME=Phil Calvin
DEVELOPER_EMAIL=phil@philcalvin.com

The final useage for this example in Android Studio will be:

dependencies {
    compile 'com.philcalvin:com-phillipcalvin-iconbutton:1.1.0'
}

You can see, the format will be PROJ_GROUP:PROJ_ARTIFACTID:PROJ_VERSION.

4. run publish command

Execute gradle bintrayUpload to publish artifacts to bintray.com.

gradle bintrayUpload

Execute gradle artifactoryPublish to publish SNAPSHOT version to oss.jfrog.org.

gradle artifactoryPublish

5. add library to Jcenter

Send a request to bintray.com about adding the library to Jcenter, after the request be approved, others can use your library by one line code in their build.gradle files.

Contributors

Special thanks to:

@dxjia for improving this README.
@stephentuso for improving bintray.gradle

介绍

本项目包含一些Gradle脚本及属性文件，用于使用Gradle发布项目.

bintray.gradle: 用于发布到JCenter的脚本。

build.gradle: 怎么使用它的Demo.

gradle.properties: 在bintray.gradle中要用到的属性，需要拷贝到你的项目中并进行配置。

如何使用

1. 保存bintray账号信息

首先注册bintray账号，地址：https://bintray.com/ ，账号生成后会自动为你分配一个API Key，账号名以及API Key是我们能够上传库到bintray的钥匙。我们需要将这些信息存到本地，也就是你的系统.gradle目录，这里要注意，我们保存在系统下，而不是你的project下的.gradle目录，如果你没有配置过GRADLE_USER_HOME的环境变量，则是在你的用户目录下，编辑gradle.properties（如果没有则创建），加入配置：

BINTRAY_USER=bintray account name
BINTRAY_KEY=bintray API Key

并且你的OS是Windows，并且是XP，那么一般是在 C:\Documents and Settings\用户名\.gradle，而如果是win7以上，那么是在c:\Users\用户名\.gradle。

2. 修改library目录下的`build.gradle`文件

首先在你的library项目中创建bintray.gradle文件，把本项目中的bintray.gradle文件内容拷贝进入，然后在你的library项目的build.gradle添加以下的构建脚本依赖：

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
        classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.6'
    }
}

接着在这个build.gradle的底部添加以下代码：

apply from: './bintray.gradle'

3. 配置library目录下的`gradle.properties`

复制本项目下的 gradle.properties文件(注意不是第二步中修改的那个文件)到你的library目录下, 点 Here 直接复制。接下来对内容进行配置，下面是一个例子：

PROJ_GROUP=com.philcalvin
PROJ_VERSION=1.1.0
PROJ_NAME=iconbutton
PROJ_WEBSITEURL=https://github.com/pnc/IconButton
PROJ_ISSUETRACKERURL=
PROJ_VCSURL=git@github.com:pnc/IconButton.git
PROJ_DESCRIPTION=android icon button
PROJ_ARTIFACTID=com-phillipcalvin-iconbutton

DEVELOPER_ID=pnc
DEVELOPER_NAME=Phil Calvin
DEVELOPER_EMAIL=phil@philcalvin.com

上面的例子最终在Android Studio中的引用形式为：

dependencies {
    compile 'com.philcalvin:com-phillipcalvin-iconbutton:1.1.0'
}

可以发现，它的格式是 PROJ_GROUP:PROJ_ARTIFACTID:PROJ_VERSION组成。

4. 执行发布命令

执行 gradle bintrayUpload 将库发布到 bintray.com.

gradle bintrayUpload

执行 gradle artifactoryPublish 可以发布版本到 oss.jfrog.org.

gradle artifactoryPublish

5. 将库加入Jcenter

最后一步，需要登录bintray.com，将我们刚刚发布的库申请加入到jcenter，这样别人才能直接引用到。

特别鸣谢

@dxjia 完善README文档
@stephentuso 完善bintray.gradle