apache/openwhisk

Docs: Add example on how to add dependencies for Java

Open

#2942 opened on Nov 7, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (6,777 stars) (1,177 forks)batch import
documentationgood first issuehelp wanted

Description

It would be good is the Java section at least shows one way to build the jar using external dependencies.

Since we all in OpenWhisk are fans of gradle 🙄 maybe we can do one using gradle.

Here is a good example from @rabbah https://github.com/rabbah/wsk-qr/blob/master/build.gradle


apply plugin: 'java'

version = '1.0'

repositories {
    mavenCentral()
}

configurations {
    provided
    compile.extendsFrom provided
}

dependencies {
    provided 'com.google.code.gson:gson:2.6.2'
    compile 'com.google.zxing:core:3.3.0'
    compile 'com.google.zxing:javase:3.3.0'
}

jar {
    dependsOn configurations.runtime

    from {
        (configurations.runtime - configurations.provided).collect {
            it.isDirectory() ? it : zipTree(it)
        }
    }
}

then build jar for Action

gradle jar

Contributor guide

Tech stack
java
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaGradle
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue suggests adding a Gradle build example for Java actions in the OpenWhisk documentation. Look at the existing Java section in the docs (likely in the repository's docs folder). The provided example from @rabbah builds a jar with dependencies. Check if the current OpenWhisk Java API supports that build method and if there are any changes. Update the docs with the example and explanation. No linked PRs or comments; the issue is straightforward.