Skip to content

Conversation

eriwen
Copy link
Contributor

@eriwen eriwen commented Aug 20, 2018

Context

This builds upon @StefMa's PR to convert the wrapper user manual doc to include Kotlin DSL samples and test them.

Passing branch build

Gradle Core Team Checklist

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation
  • Recognize contributor in release notes

@eriwen eriwen self-assigned this Aug 20, 2018
@eriwen eriwen requested a review from bamboo August 20, 2018 17:24
@eriwen eriwen added this to the 5.0 RC1 milestone Aug 20, 2018
@eriwen eriwen changed the title Ew/docs/wrapper kts Include Kotlin DSL samples in wrapper chapter Aug 20, 2018
@eriwen eriwen requested a review from pioterj August 20, 2018 17:48
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❌ Given that it's currently not possible to use named here getByName will do. I would encourage the use of the block version though since it allows for evolving the task configuration more naturally:

tasks.getByName<Wrapper>("wrapper") {
    distributionType = Wrapper.DistributionType.ALL
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated. Want to look again when you have a moment? Is this otherwise merge-able?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes you are right, that make more sense @bamboo.
Especially for new Gradle users its way more understandable 👍

Copy link
Member

@bamboo bamboo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Copy link
Contributor

@StefMa StefMa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍 :)

executable: gradle
args: tasks
commands: [{
execution-subdirectory: groovy
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you pls explain this configuration to me?
I assume that these are GradleRunner parameters, right?
But where will these be used?

Copy link
Contributor Author

@eriwen eriwen Aug 21, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a tool called Exemplar (to be open-sourced soon) that is configured to execute these samples through configuration in these files.

Basically, it looks for all .sample.conf files and executes what's inside using TestKit

@eriwen
Copy link
Contributor Author

eriwen commented Aug 21, 2018

Squashed and merged with 0a9743b — Thanks again @StefMa!

@eriwen eriwen closed this Aug 21, 2018
@eriwen eriwen deleted the ew/docs/wrapper-kts branch August 29, 2018 16:14
@ov7a ov7a removed this from the 5.0 M1 milestone Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants