isabella232 / node-versioneye-update

Update an existing project at VersionEye via node module

versioneye-update

VersionEye can monitor your project on GitHub/Bitbucket and notify you about out-dated dependencies and license violations. The integration via the GitHub/Bitbucket API works very well and is very convenient. However, this only works with publicly hosted repositories.

This module uses the VersionEye API to update an already created VersionEye project with the current revision of a monitored file. VersionEye will automatically check your project and notify you about outdated dependencies. This can be used to monitor dependency files of internally hosted projects.

The command line tool can be integrated in build jobs running on continuous integration systems like Jenkins.

Installation

$ npm install versioneye-update -g

Usage

Update a node.js project in the current directory:

$ versioneye-update --apikey <API_KEY> --projectid <PROJECT_ID> 

Upload an other project type:

$ versioneye-update --apikey <API_KEY> --projectid <PROJECT_ID> --file <PROJECT_FILE>

Upload using enterprise VersionEye API:

$ versioneye-update --apikey <API_KEY> --projectid <PROJECT_ID> --file <PROJECT_FILE> --basepath <ENTERPRISE_API_URL>

API Key

You can use some of the resources at the VersionEye API without an API KEY, but for uploading project files you need one. If you are signed up you can find your API KEY here: https://www.versioneye.com/settings/api.

Example integration

Use versioneye-update as a Jenkins Post-build Action

Supported project files

Currently VersionEye supports various package managers. You can throw any of this project files against the VersionEye API.

• Gemfile
• Gemfile.lock
• Podfile
• Podfile.lock
• package.json
• composer.json
• composer.lock
• bower.json
• requirements.txt
• setup.py
• biicode.conf
• pom.xml
• project.clj
• *.gradle
• *.sbt

Feedback

For feedback please open a ticket here on GitHub.