testarmada-magellan-admiral-plugin
v3.0.1
Published
Magellan reporter plugin that provides Admiral dashboard support
Downloads
7
Readme
Magellan Admiral Plugin
This project is a plugin for Magellan which allows you to report information about test runs to an Admiral dashboard.
PLEASE NOTE: v3.0.0 would only be compatible with Magellan v10.0.0 and higher
Installation
Install the npm module in your node project:
npm install --save testarmada-magellan-admiral-plugin
Add the plugin to magellan.json
in the reporters
list (note: if this file doesn't exist, create it)
{
"reporters": [
"testarmada-magellan-admiral-plugin"
]
}
Configuration
This plugin is configured with environment variables.
- Global
ADMIRAL_PATH
- e.g./magellan
ADMIRAL_HOST
- e.g.admiral.local-domain.net
- Project-related
ADMIRAL_AUTH_ID
- an identifier for a specific Admiral dashboard (eg:prod1
)ADMIRAL_AUTH_TOKEN
- an authentication token for that Admiral dashboard (eg:B1A6C246D46A4E7D247BA1
)
- Different for each run
MAGELLAN_BUILD_ID
- A build number (must be a number)MAGELLAN_BUILD_NAME
- A build nameBUILD_URL
- An URL to associate with this build (Travis URL, Jenkins URL, etc)