Skip to content

Commit

Permalink
doc(builders): improve gradle builder docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xizhao committed Mar 20, 2018
1 parent bffa8df commit 748f307
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/integrations/gradle.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ analyze:
type: gradle
```

NOTE: While `app` and `compile` are two very common tasks/configurations, your Gradle build may be different. For instance, many Gradle builds may use the configuration `release` instead of `compile`. See the `Troubleshooting` section below for steps in figuring out the right configuration for you.

## Troubleshooting
Since `fossa` operates directly on Gradle, it requires your build environment to be satisfied and Gradle tasks to reliably succeed before `fossa` can run.

Expand All @@ -92,7 +94,9 @@ If you're having trouble getting correct dependency data, try verifying the foll
1. Your configuration and task name is valid (i.e. `app:compile` vs `customTask:customConfiguration`) in `fossa.yml`
2. You get the desired output from your configured dependencies task `gradle {subtask}:dependencies --configuration={configuration}` (i.e. `gradle app:dependencies --configuration=compile`)

If running the gradle command in your terminal does not succeed that means your gradle build is not properly configured. If it does succeed but produces unexpected output, it means you have likely selected the wrong task or configuration for `fossa` to analyze.
If running the gradle command in your terminal does not succeed that means your gradle build is not properly configured.

If it does succeed but produces unexpected or empty output, it means you have likely selected the wrong task or configuration for `fossa` to analyze. Running without the `--configuration` will give you the full output and help you find the right configuration to select.

### Reporting issues

Expand Down

0 comments on commit 748f307

Please sign in to comment.