-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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
Improve the Gradle tooling documentation #1403
Improve the Gradle tooling documentation #1403
Conversation
- Provide Gradle Kotlin DSL examples - Avoid applying the plugins imperatively, as recommended, for a better integration of the Gradle Kotlin DSL - Use the project settings to download the plugin, instead of modifying the global Gradle settings - Use the Gradle wrapper in the shell examples - Fix a typo in the Eclipse integration See https://github.com/jnizet/quarkus-modern-gradle-example for a project using the Gradle code suggested in this commit (the kotlin-dsl branch contains the example using the Kotlin DSL)
testCompile group: 'io.rest-assured', name: 'rest-assured', version: '3.3.0' | ||
dependencies { <2> | ||
compileOnly 'io.quarkus:quarkus-resteasy:{quarkus-version}' | ||
compileOnly 'io.quarkus:quarkus-arc:{quarkus-version}' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think quarkus-arc is transitively implicit? It works for me without this over in quarkusio/quarkus-quickstarts#75 (see quarkusio/quarkus-quickstarts@master...vorburger:gradle)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If it's confirmed that it's not needed, then the getting started guide using Maven (https://quarkus.io/guides/getting-started-guide) (which I used as a basis for this gradle example) should probably be modified, too: it adds the arc dependency explicitly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jnizet it's not strictly required because indeed transitive (just verified), but I just noticed that it's everywhere (also in all quickstarts), so I guess the idea is that it's clearer to have it explicit (perhaps to illustrate that you could ditch quarkus-resteasy and still use just quarkus-arc); therefore please ignore this point and keep it here as well - sorry for the confusion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jnizet I confirm the arc dependency is not necessary. I'll fix the Maven getting started guide.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gsmet it's also in all the quickstarts ...
/Cc @stalep you may want to have a look over (or help review) this PR, if you have time. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jnizet Great improvement. Could you take care of my 2 comments? I'll merge after that. Thanks!
testCompile group: 'io.rest-assured', name: 'rest-assured', version: '3.3.0' | ||
dependencies { <2> | ||
compileOnly 'io.quarkus:quarkus-resteasy:{quarkus-version}' | ||
compileOnly 'io.quarkus:quarkus-arc:{quarkus-version}' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jnizet I confirm the arc dependency is not necessary. I'll fix the Maven getting started guide.
<2> The buildscript block can be omitted if you added it to your '~/.gradle/init.gradle' file. | ||
<3> The repositories block can be omitted if you added it to your '~/.gradle/init.gradle' file. | ||
<4> This dependency is needed for a rest application similar to the getting started example. | ||
<2> These dependencies are needed for a rest application similar to the getting started example. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor nitpick: s/rest/REST/
@gsmet done. |
- rest -> REST - remove unnecessary arc dependency
See https://github.com/jnizet/quarkus-modern-gradle-example for a project using the Gradle code suggested in this commit (the kotlin-dsl branch contains the example using the Kotlin DSL)