-
Notifications
You must be signed in to change notification settings - Fork 171
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docs): add maven docs and alpha notice
- Loading branch information
Showing
2 changed files
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Maven Support | ||
|
||
Maven support in `fossa-cli` depends on the following tools existing in your environment: | ||
|
||
- Java | ||
- Maven | ||
- `mvn:dependencyList` plugin (auto-installed if missing) | ||
|
||
## Configuration | ||
|
||
Add a `MavenArtifact` module with the **relative** path to the `pom.xml` in your root directory. | ||
|
||
```yaml | ||
analyze: | ||
modules: | ||
- name: yourmavenpackage | ||
path: pom.xml | ||
type: MavenArtifact | ||
``` | ||
|
||
If you have an existing passing production build, you can run `fossa` in your existing environment and it should succeed. | ||
|
||
Otherwise, you can run `fossa --install` to execute with a default build command `mvn clean install -DskipTests -Drat.skip=true -f $PATH_TO_POM`. | ||
|
||
## Troubleshooting | ||
|
||
`fossa-cli` runs and parses the output of the `mvn:dependencyList` plugin to generate dependency IDs. If FOSSA fails, chances are your build or the `mvn:dependencyList` plugin is failing. | ||
|
||
Run `mvn:dependencyList -f $PATH_TO_POM` and check the output to diagnose what went wrong. |