Skip to content
This repository has been archived by the owner on Feb 3, 2021. It is now read-only.

Commit

Permalink
Merge pull request #212 from mockito/eanble-shippinng-javadoc
Browse files Browse the repository at this point in the history
Enable Shipping Javadoc, bump Gradle version to 4.0

Just merge to verify new plugin
  • Loading branch information
mstachniuk authored Mar 17, 2019
2 parents 7f74b7c + a25ea0b commit ec732cc
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 1 deletion.
2 changes: 2 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -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"
26 changes: 26 additions & 0 deletions gradle/shipkit.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit ec732cc

Please sign in to comment.