Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 36 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,71 +51,71 @@ If you need additional request parameters you can add them as explained in 'opti

#### build
```javascript
jenkins.build('job-in-jenkins', (optional){token: 'jenkins-token', ...}, function(err, data) {
jenkins.build('job-in-jenkins', (optional){token: 'jenkins-token', crumbFlag: true, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### build_with_params
```javascript
jenkins.build_with_params('job-in-jenkins', (optional){depth: 1, <param>:<value>, token: 'jenkins-token',...}, function(err, data) {
jenkins.build_with_params('job-in-jenkins', (optional){depth: 1, crumbFlag: true, <param>:<value>, token: 'jenkins-token',...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### stop build
```javascript
jenkins.stop_build('job-in-jenkins', 'build-number', (optional){token: 'jenkins-token', ...}, function(err, data) {
jenkins.stop_build('job-in-jenkins', 'build-number', (optional){token: 'jenkins-token', crumbFlag: true, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### console output
```javascript
jenkins.console_output('job-in-jenkins', 'buildname', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.console_output('job-in-jenkins', 'buildname', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### build info
```javascript
jenkins.build_info('job-in-jenkins', 'build-number', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.build_info('job-in-jenkins', 'build-number', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### last build info
```javascript
jenkins.last_build_info('job-in-jenkins', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.last_build_info('job-in-jenkins', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### last completed build info
```javascript
jenkins.last_completed_build_info('job-in-jenkins', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.last_completed_build_info('job-in-jenkins', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### all builds
```javascript
jenkins.all_builds('job-in-jenkins', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.all_builds('job-in-jenkins', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### test result/report
```javascript
jenkins.test_result('job-in-jenkins', 'build-number', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.test_result('job-in-jenkins', 'build-number', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
Expand All @@ -131,7 +131,7 @@ jenkins.test_result('job-in-jenkins', 'build-number', (optional) {depth: 1, <par

#### delete build data for job
```javascript
jenkins.delete_build('job-in-jenkins', 'build-number', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.delete_build('job-in-jenkins', 'build-number', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
Expand All @@ -142,15 +142,15 @@ jenkins.delete_build('job-in-jenkins', 'build-number', (optional) {depth: 1, <pa

#### all jobs
```javascript
jenkins.all_jobs((optional){token: 'jenkins-token', ...}, function(err, data) {
jenkins.all_jobs((optional){token: 'jenkins-token', crumbFlag: true, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### get config xml
```javascript
jenkins.get_config_xml('job-in-jenkins', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.get_config_xml('job-in-jenkins', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
Expand All @@ -164,7 +164,7 @@ jenkins.update_config('job-to-update'
// the new config xml for the new job
return config.replace('development','feature-branch');
}
,(optional){token: 'jenkins-token', ...}
,(optional){token: 'jenkins-token', crumbFlag: true, ...}
,function(err, data) {
// if no error, job was copied
if (err){ return console.log(err); }
Expand All @@ -174,7 +174,7 @@ jenkins.update_config('job-to-update'

#### update job
```javascript
jenkins.update_job('job-to-update', xmlConfigString, (optional){token: 'jenkins-token', ...}, function(err, data) {
jenkins.update_job('job-to-update', xmlConfigString, (optional){token: 'jenkins-token', crumbFlag: true, ...}, function(err, data) {
// if no error, job was copied
if (err){ return console.log(err); }
console.log(data)
Expand All @@ -183,15 +183,15 @@ jenkins.update_job('job-to-update', xmlConfigString, (optional){token: 'jenkins-

#### job info
```javascript
jenkins.job_info('job-in-jenkins', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.job_info('job-in-jenkins', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### create job
```javascript
jenkins.create_job('job-in-jenkins', xmlConfigString, (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.create_job('job-in-jenkins', xmlConfigString, (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
Expand All @@ -206,7 +206,7 @@ jenkins.copy_job('job-to-copy'
// the new config xml for the new job
return config.replace('development','feature-branch');
}
,(optional){token: 'jenkins-token', ...}
,(optional){token: 'jenkins-token', crumbFlag: true, ...}
,function(err, data) {
// if no error, job was copied
if (err){ return console.log(err); }
Expand All @@ -216,39 +216,39 @@ jenkins.copy_job('job-to-copy'

#### delete job
```javascript
jenkins.delete_job('job-in-jenkins', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.delete_job('job-in-jenkins', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### enable job
```javascript
jenkins.enable_job('job-in-jenkins', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.enable_job('job-in-jenkins', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### disable job
```javascript
jenkins.disable_job('job-in-jenkins', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.disable_job('job-in-jenkins', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### last success
```javascript
jenkins.last_success('job-in-jenkins', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.last_success('job-in-jenkins', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### last result
```javascript
jenkins.last_result('job-in-jenkins', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.last_result('job-in-jenkins', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
Expand All @@ -259,31 +259,31 @@ jenkins.last_result('job-in-jenkins', (optional) {depth: 1, <param>:<value>, ...

#### get all queued items
```javascript
jenkins.queue((optional){token: 'jenkins-token', ...}, function(err, data) {
jenkins.queue((optional){token: 'jenkins-token', crumbFlag: true, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### get one queued item
```javascript
jenkins.queue_item('queue-item-number', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.queue_item('queue-item-number', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### cancel queued item
```javascript
jenkins.cancel_item('queue-item-number', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.cancel_item('queue-item-number', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### get all jenkins computers (aka workers)
```javascript
jenkins.computers((optional){token: 'jenkins-token', ...}, function(err, data) {
jenkins.computers((optional){token: 'jenkins-token', crumbFlag: true, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
Expand All @@ -294,23 +294,23 @@ jenkins.computers((optional){token: 'jenkins-token', ...}, function(err, data) {

#### get all views
```javascript
jenkins.all_views((optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.all_views((optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### create view
```javascript
jenkins.create_view('new-view-name', (optional)viewMode = 'hudson.model.ListView', (optional){token: 'jenkins-token', ...}, function(err, data) {
jenkins.create_view('new-view-name', (optional)viewMode = 'hudson.model.ListView', (optional){token: 'jenkins-token', crumbFlag: true, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### view info
```javascript
jenkins.create_view('view-name', (optional){token: 'jenkins-token', ...}, function(err, data) {
jenkins.create_view('view-name', (optional){token: 'jenkins-token', crumbFlag: true, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
Expand All @@ -328,39 +328,39 @@ var viewConfig = {
"columns": [{"stapler-class": "hudson.views.StatusColumn", "$class": "hudson.views.StatusColumn"}, {"stapler-class": "hudson.views.WeatherColumn", "$class": "hudson.views.WeatherColumn"}, {"stapler-class": "hudson.views.JobColumn", "$class": "hudson.views.JobColumn"}, {"stapler-class": "hudson.views.LastSuccessColumn", "$class": "hudson.views.LastSuccessColumn"}, {"stapler-class": "hudson.views.LastFailureColumn", "$class": "hudson.views.LastFailureColumn"}, {"stapler-class": "hudson.views.LastDurationColumn", "$class": "hudson.views.LastDurationColumn"}, {"stapler-class": "hudson.views.BuildButtonColumn", "$class": "hudson.views.BuildButtonColumn"}]
};

jenkins.update_view('view-in-jenkins', viewConfig, (optional){token: 'jenkins-token', ...}, function(err, data) {
jenkins.update_view('view-in-jenkins', viewConfig, (optional){token: 'jenkins-token', crumbFlag: true, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### delete view
```javascript
jenkins.delete_view('view-in-jenkins', (optional){token: 'jenkins-token', ...}, function(err, data) {
jenkins.delete_view('view-in-jenkins', (optional){token: 'jenkins-token', crumbFlag: true, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### add job to view
```javascript
jenkins.add_job_to_view('view-in-jenkins', 'job-in-jenkins', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.add_job_to_view('view-in-jenkins', 'job-in-jenkins', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### remove job from view
```javascript
jenkins.remove_job_from_view('view-in-jenkins', 'job-in-jenkins', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.remove_job_from_view('view-in-jenkins', 'job-in-jenkins', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
```

#### get all jobs in view
```javascript
jenkins.all_jobs_in_view('view-in-jenkins', (optional) {depth: 1, <param>:<value>, ...}, function(err, data) {
jenkins.all_jobs_in_view('view-in-jenkins', (optional) {depth: 1, crumbFlag: true, <param>:<value>, ...}, function(err, data) {
if (err){ return console.log(err); }
console.log(data)
});
Expand All @@ -371,7 +371,7 @@ jenkins.all_jobs_in_view('view-in-jenkins', (optional) {depth: 1, <param>:<value

#### get all installed plugins
```javascript
jenkins.all_installed_plugins((optional){token: 'jenkins-token', ...}, function(err, data){
jenkins.all_installed_plugins((optional){token: 'jenkins-token', crumbFlag: true, ...}, function(err, data){
if (err){ return console.log(err); }
console.log(data)
})
Expand All @@ -381,7 +381,7 @@ jenkins.all_installed_plugins((optional){token: 'jenkins-token', ...}, function(
```javascript
// var plugin = 'copyartifact@1.3.8';
var plugin = 'copyartifact@current';
jenkins.install_plugin(plugin, (optional){token: 'jenkins-token', ...}, function(err, data){
jenkins.install_plugin(plugin, (optional){token: 'jenkins-token', crumbFlag: true, ...}, function(err, data){
if (err){ return console.log(err, data); }
console.log(data)
});
Expand Down
Loading