erik/kobalt-versioneye
erik/kobalt-versioneye
1
0
Fork 0
Code Issues Pull requests Releases Activity

More readme.

Browse source
This commit is contained in:
Erik C. Thauvin 2016-07-30 23:14:52 -07:00
parent 4f50b84f86
commit e90731f47b
1 changed files with 80 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

81
README.md
View file

@ -21,6 +21,7 @@ val p = project {
version = "0.1"
versionEye {
}
```
To create or update your project on VersionEye, you will need an API key. If you are [signed up](https://www.versioneye.com/signup), you can find your API Key [here](https://www.versioneye.com/settings/api):
@ -39,10 +40,88 @@ Upon running the above command the plug-in will output something like:
[![Example Report](src/site/images/ExampleReport.png)]
The repot is based on the Traffic Light concept:
The repot is based on the *Traffic Light* concept:
1. Green items are clear.
2. Yellow items may require some attention.
3. Red items will cause the build to fail.
By default the plug-in is configured to only fail on known security vulnerability.
## Global Configuration
You can configure the VersionEye **API Key** and **Project Key** (if you already have one) in one of two ways.
1. Using the command line:
``` bash
./kobaltw -Dversioneye.ApiKey=YOUR_API_KEY -Dversionkey.projectKey=YOUR_PROJECT_KEY versionEye
```
..* These keys will be save automatically in the `local.properties` file.
2. In the `local.properties` file:
```
versioneye.ApiKey=YOUR_API_KEY
versioneye.projectKey=YOUR_PROJECT_KEY
```
### Task Configuration
Configuration options are available in `versionEye` task:
```
versionEye {
baseUrl = "https://www.versioneye.com/"
colors = true
name = ""
org = ""
quiet = false
team = ""
verbose = true
visibility = "public"
failOn(Fail.securityCheck)
}
```
The values are:
| Value | Description | Default |
--------------|-------------------------------------------------------------------------------------------------|-------------------------------|
| `baseUrl` | For VersionEye Enterprise VM to use their own url, e.g. `https://versioneye.my-company.com/` | `https://www.versioneye.com/` |
| `colors` | To enable (`true`) or disable (`false`) colors in the plug-in output. | `true` |
| `name` | The name of the VersionEye project, if none are specified the Kobalt project name will be used. | *none* |
| `quiet` | To completely disable output from the plug-in. | `false` |
| `org` | The VersionEye organisation, if any. | *none* |
| `team` | The VersionEye team, if any. | *none* |
| `vebose` | To enable or disable extra information in the plug-in output. | `true` |
| `visbility` | To set the project's visibility on VersionEye, either `public` or `private` | `public` |
Some of the options can be controlled temporarily from the command line, as follows:
```bash
./kobaltw -Dve.colors=false versionEye
./kobaltw -Dve.verbose=false versionEye
./kobaltw -Dve.quiet=true versionEye
./kobaltw -Dve.colors=false -Dve.verbose=false versionEye
```
### Failures Configuration
The `failOn` directive can be used to trigger specific failures:
```
versionEye {
failOn(Fail.securityCheck, Fail.licensesCheck)
}
```
|Fail On | Description |
|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
| `Fail.dependenciesCheck` | Will triggered a failure on outdated dependencies. |
| `Fail.licensesUnknownCheck` | Will trigger a failure on unknown licenses. |
| `Fail.licensesCheck` | Will trigger a failure on licences whitelist violations. Licenses and components whitelists can be configured on the VersionEye website. |
| `Fail.securityCheck` | Will trigger a failure on known security vulnerabilities, on by default. |