Documentation

Documentation

Setting up a GitHub project

There are different ways to setup & monitor a project with VersionEye. But the most comfortable way is to use the GitHub integration. Simply login to VersionEye with your existing GitHub account and naviate to "Projects -> Create from GitHub". Here you will see all your GitHub repositories listed. You can filter down the list by typing in the name of the desired repository.

Github repos

Simply click on the repository name you would like to monitor. VersionEye will show you all branches and supported project files in that repository. Like in this example below.

Github files

Simply click on the switch directly next to the file you would like to monitor with VersionEye. If you click on a Gemfile, VersionEye will do a lookup for the corresponding Gemfile.lock in that branch and fetch that file as well. Both files will be merged into the same project view. If everything worked out you will see somthing similar to this one.

Github files done

Now you can click on the file name to see more details about the project.

Ve project versions

In the example above we can see that 2 dependencies in the Gemfile are out-dated. Above the versions table we can switch to the Gemfile.lock or to a summary view, which shows all the out-dated dependencies combined from both files. Beside the Versions tab there are tabs for Licenses and Security. In the top of the page we can see that 14 out of 60 dependencies are out-dated, 1 has a known security vulnerability and there are 0 license violations. To see more details about the licenses and security issues please click on the corresponding tab.

By default VersionEye will check your project once a day and send you an email notification if there are out-dated dependencies, license violations or security vulnerabilities for your dependencies.

Setting up a Bitbucket project

Works the same way as for GitHub.

Setting up a complex Maven project

Maven is the default build tool for Java projects. Big Maven projects can become complex and usually their dependencies are distributed over several XML files. Currently VersionEye does not resolves this file dependencies via the GitHub/Bitbucket API. Please use the VersionEye Maven Plugin for Maven projects which has more than 1 pom.xml file.

Futher Questions

You have questions? Please take a look to the FAQ page. If you still have questions contact us on Twitter or write an email to "support [at] versioneye.com".