From a25ea0b17978c3443de47b2eaf195d59aa072d3b Mon Sep 17 00:00:00 2001 From: Marcin Stachniuk Date: Sun, 17 Mar 2019 22:54:34 +0100 Subject: [PATCH] Enable Shipping Javadoc, bump Gradle version to 4.0 --- build.gradle | 2 ++ gradle/shipkit.gradle | 26 ++++++++++++++++++++++++ gradle/wrapper/gradle-wrapper.properties | 2 +- 3 files changed, 29 insertions(+), 1 deletion(-) diff --git a/build.gradle b/build.gradle index 41c1e61..b9fea1b 100644 --- a/build.gradle +++ b/build.gradle @@ -19,5 +19,7 @@ allprojects { // enable Shipkit Java plugin. All Shipkit configuration will be stored in gradle/shipkit.gradle file apply plugin: "org.shipkit.java" +// enable Shipkit Javadoc plugin. Now Javadoc can be shipped to the Git repository +apply plugin: "org.shipkit.javadoc" apply from: "gradle/ide.gradle" diff --git a/gradle/shipkit.gradle b/gradle/shipkit.gradle index 74f5994..9bb535d 100644 --- a/gradle/shipkit.gradle +++ b/gradle/shipkit.gradle @@ -83,6 +83,32 @@ shipkit { // It should be VCS name (e.g. 'Szczepan Faber', 'shipkit-org', 'Marcin Stachniuk'). // Ignored contributors takes precedence over contributors configuration. // team.ignoredContributors = [] + + // OPTIONAL GitHub repository (owner/repo) where Javadocs are shipped. + // To enable shipping Javadoc you need to apply Javadoc plugin first: + // apply plugin: "org.shipkit.javadoc" + // The default value is gitHub.repository + "-javadoc", so in this project case: + // https://github.com/mockito/shipkit-example-javadoc +// javadoc.repository = "mstachniuk/shipkit-example-javadoc" + + // OPTIONAL GitHub Javadoc repository branch name. The branch needs to exist. + // By default it's using the branch set as main in GitHub repo, usually master. + // To enable shipping Javadoc you need to apply Javadoc plugin first: + // apply plugin: "org.shipkit.javadoc" +// javadoc.repositoryBranch = "" + + // OPTIONAL GitHub Javadoc repository directory where put javadoc files. By default it's project root directory. + // To enable shipping Javadoc you need to apply Javadoc plugin first: + // apply plugin: "org.shipkit.javadoc" +// javadoc.repositoryDirectory = "" + + // OPTIONAL Commit message used to commit Javadocs. Default: "Update current and ${version} Javadocs. [ci skip]" + // You can override this message and ${version} will be replaced by currently build version. + // You don't need to specify "[ci skip]" in your message - it will be added automatically. + // To enable shipping Javadoc you need to apply Javadoc plugin first: + // apply plugin: "org.shipkit.javadoc" +// javadoc.commitMessage = "" + } allprojects { diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 203b329..38ae936 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-3.5-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-4.0-bin.zip