#Grunt Jenkins Runner

a grunt task to init a jenkins build from grunt

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-jenkins-runner --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-jenkins-runner');

The "jenkins-runner" task

Overview

In your project's Gruntfile, add a section named jenkins-runner to the data object passed into grunt.initConfig().

grunt.initConfig({
  jenkins-runner: {
    options: {
      // Task-specific options go here.
    },
    your-target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.jenkinsUrl

Type: String Default value: http://www.example.com

A URL to your jenkins build server.

options.jobName

Type: String Default value: test-job-1

the name of the job you wish to run.

options.auth

Type: {username: 'String', password: 'String'}

Optional property is you need auth with Jenkins.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.