Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation. #48

Merged
merged 1 commit into from Mar 6, 2017
Merged

Update documentation. #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Expand Up @@ -137,12 +137,21 @@ Programmatically:
'http://user:pass@host:port/path'
);

// trigger a standard build
nestor.buildJob('job', '', function (err, result) {
});

// trigger a parameterised build
nestor.build('job', 'param1=value1&param2=value2', function (err, result) {
nestor.buildJob('job', 'param1=value1&param2=value2', function (err, result) {
});

Check out [lib/jenkins](https://github.com/cliffano/nestor/blob/master/lib/jenkins.js) for other available methods.

Note: `<job>` in the examples is a part of your Jenkins job URL after the first `job/`.

For example, if you use nested folders on Jenkins and your URL is `/job/myproject/job/releases/job/master`,
then you should pass `myproject/job/releases/job/master` as `<job>`.

Configuration
-------------
### Jenkins URL
Expand Down
2 changes: 1 addition & 1 deletion lib/api/job.js
View file
Open in desktop
Expand Up @@ -89,7 +89,7 @@ function _delete(name, cb) {
* Build a job.
*
* @param {String} name: Jenkins job name
* @param {Object} params: build parameters key-value pairs
* @param {Object|String} params: build parameters key-value pairs, passed as object or 'a=b&c=d' string
* @param {Function} cb: standard cb(err, result) callback
*/
function build(name, params, cb) {
Expand Down