New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Help popular Gradle plugins provide Kotlin DSL usage samples #6790

Open
eriwen opened this Issue Sep 17, 2018 · 18 comments

Comments

Projects
None yet
@eriwen
Copy link
Member

eriwen commented Sep 17, 2018

We want the Kotlin DSL to be a viable alternative for a large number of projects. Now that the vast majority of Gradle documentation (in the nightly docs) includes Kotlin DSL examples alongside Groovy DSL ones, we want to get Kotlin DSL examples for popular plugins as well.

Some of these will be promoted in our Gradle Kotlin DSL 1.0 guides and docs. Please feel free to suggest others we should get in touch with or link to your own plugin examples.

Plugin authors can verify your samples using the same library that Gradle does: Exemplar. You are welcome to reach out directly to eric@gradle.com for help with Kotlin DSL samples or Exemplar.

In case you missed it, here's the Migrating Build Scripts from Groovy to Kotlin guide.

Plugin Status Issue/PR
Android 🔴 -
Crashlytics 🔴 -
Firebase 🔴 -
Android Check 2 💚 stoyicker/android-check-2#119
Spotless 🔴 diffplug/spotless#310
Kotlinter 💚 jeremymailen/kotlinter-gradle#78
Dex Count 🔴 KeepSafe/dexcount-gradle-plugin#258
android-junit5 🔴 mannodermaus/android-junit5#119
APT 💚 tbroyer/gradle-apt-plugin#92
Android Play Publisher 💚 Triple-T/gradle-play-publisher#445
Kotlin and Kotlin Docs 🔴 -
Detekt 💚 -
Spring Dependency Management 🔴 spring-gradle-plugins/dependency-management-plugin#232
Spring Boot 💚 spring-projects/spring-boot#14585
Versions 💚 ben-manes/gradle-versions-plugin#267
Shadow 🔴 johnrengelman/shadow#417
Bintray 🔴 bintray/gradle-bintray-plugin#265
Docker 💚 -
Git Publish 🔴 ajoberstar/gradle-git-publish#61
Build Scan 💚 -
Dependency Graph Generator 🔴 vanniktech/gradle-dependency-graph-generator-plugin#79

@eriwen eriwen added the in:docs label Sep 17, 2018

@eriwen eriwen self-assigned this Sep 17, 2018

@gildor

This comment has been minimized.

Copy link

gildor commented Sep 18, 2018

Link on Kotlin plugin is broken.
Probably should be https://github.com/JetBrains/kotlin/tree/master/libraries/tools/kotlin-gradle-plugin

Also Kotlin docs should be changed on this page of official reference:
https://kotlinlang.org/docs/reference/using-gradle.html

@StefMa

This comment has been minimized.

Copy link
Contributor

StefMa commented Sep 19, 2018

Kotlins Dokka plugin should show the Kotlin DSL usage.

Here is the issue for it: Kotlin/dokka#359

@eriwen

This comment has been minimized.

Copy link
Member

eriwen commented Sep 19, 2018

Thanks @gildor. Fixed.

Thank you for filing an issue @StefMa. Is Dokka widely used do you think?

@StefMa

This comment has been minimized.

Copy link
Contributor

StefMa commented Sep 20, 2018

@deeprim

This comment has been minimized.

Copy link

deeprim commented Sep 20, 2018

Hi @eriwen,

I believe Detekt, should be on the list,
Thanks

@jnizet

This comment has been minimized.

Copy link
Contributor

jnizet commented Sep 20, 2018

I have opened an issue on the Spring Boot project and offered my help for its translation.

@eriwen

This comment has been minimized.

Copy link
Member

eriwen commented Sep 20, 2018

Thanks @deeprim, I've added it.

That's awesome @jnizet!

@mkobit

This comment has been minimized.

Copy link
Contributor

mkobit commented Sep 20, 2018

For https://github.com/ben-manes/gradle-versions-plugin, an example and test was added in ben-manes/gradle-versions-plugin#237 and is available in v0.18.0+

@mkobit

This comment has been minimized.

Copy link
Contributor

mkobit commented Sep 20, 2018

Nebula Lint plugin is currently blocked and fails immediately if attempted to use with the kotlin-dsl (nebula-plugins/gradle-lint-plugin#166)

@JLLeitschuh

This comment has been minimized.

Copy link
Contributor

JLLeitschuh commented Sep 25, 2018

@nedtwigg Spotless is on this list.

@bmuschko

This comment has been minimized.

Copy link
Contributor

bmuschko commented Oct 11, 2018

@eriwen An initial implementation has been added to the Docker plugin and will be released soon. There are still some use cases that require a change to the plugin code I believe before it can be used from the Kotlin DSL.

@eriwen

This comment has been minimized.

Copy link
Member

eriwen commented Oct 11, 2018

Thanks for the update @bmuschko.

@jmfayard

This comment has been minimized.

Copy link
Contributor

jmfayard commented Oct 24, 2018

@eriwen
I would suggest to convert your list of plugins with a markdown table with links to the relevant issues if they exist

| project               | status                                 |
|---------------------------|-----------------------------------------|
| dexcount-gradle-plugin |  [OK, see #256](https://github.com/KeepSafe//issues/256)  |
| ...   | ...
@aalmiray

This comment has been minimized.

Copy link
Member

aalmiray commented Nov 7, 2018

The guide for https://github.com/aalmiray/kordamp-gradle-plugins version 0.7.0 now displays Groovy & Kotlin examples. See aalmiray/kordamp-gradle-plugins#25

@eriwen

This comment has been minimized.

Copy link
Member

eriwen commented Nov 12, 2018

Thanks @aalmiray!

@mannodermaus

This comment has been minimized.

Copy link

mannodermaus commented Nov 20, 2018

As mentioned in mannodermaus/android-junit5#119, android-junit5 now shows Kotlin examples in its README, and there are dedicated sections on the project's wiki.

@jmfayard

This comment has been minimized.

Copy link
Contributor

jmfayard commented Nov 28, 2018

@eriwen ben-manes/gradle-versions-plugin#267 is now resolved, you can update the status of the Versions plugin!

@eriwen

This comment has been minimized.

Copy link
Member

eriwen commented Dec 4, 2018

Done with pleasure @jmfayard. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment