Categorygithub.com/jenkins-x/golang-jenkins
modulepackage
0.0.0-20180919102630-65b83ad42314
Repository: https://github.com/jenkins-x/golang-jenkins.git
Documentation: pkg.go.dev

# README

golang-jenkins

.. image:: https://badges.gitter.im/Join%20Chat.svg :alt: Join the chat at https://gitter.im/yosida95/golang-jenkins :target: https://gitter.im/yosida95/golang-jenkins?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge


About

This is a API client of Jenkins API written in Go.


Usage

import "github.com/yosida95/golang-jenkins"

Configure authentication and create an instance of the client:

.. code-block:: go

auth := &gojenkins.Auth{ Username: "[jenkins user name]", ApiToken: "[jenkins API token]", } jenkins := gojenkins.NewJenkins(auth, "[jenkins instance base url]")

Make calls against the desired resources:

.. code-block:: go

job, err := jenkins.GetJob("[job name]")


License

golang-jenkins is licensed under the MIT LICENSE. See ./LICENSE <./LICENSE>_.

# Packages

No description provided by the author

# Functions

FullJobPath returns the full job path URL for the given paths.
FullJobPath returns the full job path URL for the given paths.
JobToXml converts the given JobItem into XML.
NewConditionFunc combines the functions into a single function that can be used when polling.
No description provided by the author
No description provided by the author
Poll polls the given function until it returns true to indicate its complete or an error.
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Parameter for a build.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author
JenkinsClient is the interface for interacting with jenkinsgo:generate pegomock generate github.com/jenkins-x/golang-jenkins JenkinsClient -o mocks/jenkins_client.go --package gojenkins_test.
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

ConditionFunc returns true if the condition is satisfied, or an error if the loop should be aborted.