scabbard icon indicating copy to clipboard operation
scabbard copied to clipboard

Provide simple sample

Open Fbada006 opened this issue 4 years ago • 3 comments

Could you please provide a simple sample app for groovy to get started easily? The docs are not naturally intuitive. As it is, I have not been able to generate the graph and I am not sure if it is the library itself or a wrong setup.

Fbada006 avatar Mar 05 '20 08:03 Fbada006

I would second this, I have 2 different projects that have the same lines added in build.gradle, but one works and the other doesn't.

Setting failOnError to true doesn't have any effect and I'm not sure how else to debug

robichaudc avatar Apr 09 '20 22:04 robichaudc

Hi thanks for reporting, since version 0.2.0, I have tried to make it simple especially for multi-module projects. Adding the scabbard plugin and the configuration in the root build.gradle file should be enough.

This is a sample setup: https://github.com/arunkumar9t2/scabbard/blob/master/samples/coffee-java/build.gradle

@robichaudc for next version I plan on adding diagnostics to help in identifying issues in the mean time are you able to share Kotlin, Dagger Version, AGP version of the project that is not working? Thanks!

@Fbada006 would love to hear feedback on how docs could be improved, thanks. Please let me know if above sample helps.

arunkumar9t2 avatar Apr 10 '20 03:04 arunkumar9t2

Hello. Thanks for getting back to me. As I was going through the sample, it was difficult figuring out what goes where not to mention that the samples do not use Groovy, which is more popular. Here are my suggestions:

  1. Set up a complete but simple sample of Groovy to quickly get users started.
  2. Perhaps a known issues section to help users. This is because I had problems determining what was going wrong. To be honest, I kinda stumbled onto the solution and I am not sure if I could do it again.
  3. This is a question. Is the library supposed to show the graph whether or not the build is successful? Because for unsuccessful builds, there is no graph generated. Thanks once again. Really helpful library here.

Fbada006 avatar Apr 10 '20 11:04 Fbada006