https://github.com/mattumotu/jenkinsnetclient

a light weight, object-oriented .Net SDK for interacting with Jenkins
https://github.com/mattumotu/jenkinsnetclient

csharp dotnet jenkins

Last synced: 19 days ago
JSON representation

a light weight, object-oriented .Net SDK for interacting with Jenkins

• Host: GitHub
• URL: https://github.com/mattumotu/jenkinsnetclient
• Owner: mattumotu
• License: bsd-3-clause
• Created: 2017-11-01T12:14:06.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-11-24T09:55:28.000Z (about 4 years ago)
• Last Synced: 2024-12-17T02:57:13.719Z (about 2 months ago)
• Topics: csharp, dotnet, jenkins
• Language: C#
• Homepage:
• Size: 102 KB
• Stars: 1
• Watchers: 1
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# JenkinsNet

![JenkinsNET Logo](https://raw.githubusercontent.com/mattumotu/jenkinsnetclient/master/jenkinsnetclient.png "JenkinsNETClient Logo") 

Allows for easy and simple C# interaction with Jenkins.

[![Build status](https://ci.appveyor.com/api/projects/status/i0a30nv83layh93d/branch/master?svg=true)](https://ci.appveyor.com/project/mattumotu/jenkinsnetclient/branch/master)

[![Coverage Status](https://coveralls.io/repos/github/mattumotu/jenkinsnetclient/badge.svg?branch=master)](https://coveralls.io/github/mattumotu/jenkinsnetclient?branch=master)

[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=mattumotu_jenkinsnetclient&metric=alert_status)](https://sonarcloud.io/dashboard?id=mattumotu_jenkinsnetclient)

[![NuGet](https://img.shields.io/nuget/v/jenkinsnetclient.svg)](https://www.nuget.org/packages/JenkinsNetClient/)

## Installation

Via NuGet

    PM> Install-Package JenkinsNetClient

    

## Usage

### Basics

First you need a connection to a jenkins server, just pass it your jenkins instance's url.

```cs

JenkinsConnection myConn = new JenkinsConnection("myjenkins");

```

If Jenkins is secuired then you will have to provide a username and api token:

```cs

JenkinsConnection myConn = new JenkinsConnection("myjenkins", "username", "apitoken");

```

We can get a list of Views and Jobs from a JenkinsServer

```cs

var myJenkins = new JenkinsServer(myConn);

List views = myJenkins.Views();

List jobs = myJenkins.Jobs();

```

### Playing with views

We can easily create a new view ...

```cs

var newView = new JenkinsView(myConn, "hudson.model.ListView", "Name of my new view");

if(newView.Exists()) 

{

  throw new exception("View already exists on jenkins");

}

newView.Create(); // Create on jenkins

if(!newView.Exists()) 

{

  throw new exception("View doesn't exist on jenkins - Create must have failed");

}

```

... or delete an existing view

```cs

JenkinsView existingView = views[0];

existingView.Delete(); // Delete from jenkins

if(existingView.Exists()) 

{

  throw new exception("View still exists on jenkins - delete failed");

}

```

### Playing with Jobs

```cs

var newJob = new JenkinsJob(myConn, "hudson.model.FreeStyleProject", "name of new job");

if(newJob.Exists()) 

{

  throw new exception("job already exists on jenkins");

}

newJob.Create(); // Create job on jenkins

if(!newJob.Exists()) 

{

  throw new exception("job doesn't exist on jenkins after call to create");

}

newJob.Delete();

if(newJob.Exists()) 

{

  throw new exception("job still exists on jenkins after call to delete");

}           

```

### Jobs and Views 

Adding an existing job to a view ...

```cs

JenkinsJob existingJob = Jobs[0];

JenkinsView existingView = views[0];

if(!existingView.Contains(existingJob))

{

  existingView.Add(existingJob);

}

if(!existingView.Contains(existingJob)) 

{

  throw new exception("Add failed");

}

```

... and removing it again.

```cs

existingView.Remove(existingJob);

if(existingView.Contains(existingJob)) 

{

  throw new exception("job still on view - remove failed");

}

```

### Getting and Setting config.xml

Getting the config xml for a job

```cs

JenkinsJob existingJob = Jobs[0];

string configXml = existingJob.Config;

```

and setting it

```cs

JenkinsJob existingJob = Jobs[0];

existingJob.Config = xml

```