Skip to content

Commit

Permalink
feat(docs): add maven docs and alpha notice
Browse files Browse the repository at this point in the history
  • Loading branch information
xizhao committed Feb 7, 2018
1 parent e3ccd88 commit 4df5715
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ This tool integrates directly with the [FOSSA](https://fossa.io) web service to

The CLI provides an alternative path to integrating your code repositories and builds in a way that doesn't require code access or FOSSA environment setup, or enrich dependency reports with dynamically confirmed dependency artifacts.

**FOSSA CLI is currently in alpha and will have a changing API; join our contributor group to get development updates**

## Installation

`fossa-cli` is compatible with Windows, Darwin (MacOS) and *nix-based operating systems.
Expand Down
29 changes: 29 additions & 0 deletions docs/maven.md
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.

0 comments on commit 4df5715

Please sign in to comment.