Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 2.6 KB

README.md

File metadata and controls

64 lines (40 loc) · 2.6 KB
Raw

Semaphore CI API Client

This library is intended to be used as a simple client for the Semaphore CI REST API. The library supports Semaphore CI API version 1. It wraps the API calls covering most of the available API endpoints, enabling you to securely:

All the responses from the API are in turn mapped into the corresponding Java objects (defined in org.devfort.semaphoreci4j.model package).

Getting Started

In order to use the library, you should first:

  • Clone the repository
$ git clone https://github.com/ksokolovic/semaphoreci4j.git
  • Build the project
# Including tests 
$ gradle clean build

# Without tests
$ gradle clean build -x test
  • Add the semaphoreci4j library to your project classpath.

Usage

Since Semaphore CI requires all API requests to be authenticated, as the first step you should obtain your API authentication token. Head over to this page, and copy the token which is shown at the bottom of the page.

The org.devfort.semaphoreci4j.SemaphoreCI class is the entry point class for interacting with the Semaphore API. You create a reference to it using the previously obtained authentication token:

SemaphoreCI semaphore = new SemaphoreCI("authentication-token");

At the top level you can list your projects, which are returned as a map of project names to projects:

Map<String, Project> projects = semaphoreCI.getProjects();

Alternatively, you can request for a specific project by its name, using the getProject("project-name") method of the SemaphoreCI class.

The Project instance will in turn allow you to access all the relevant information listed above.

Contribution

Issues

In case you run into any issues while using the library or have a suggestion for improving it, please create an issue here, with as detailed as possible description of what's going on; a working example, code snippet or log file are the best.

License

Copyright (c) Kemal Sokolović [kemal DOT sokolovic AT gmail DOT com], Miloš Panasiuk [milos DOT panasiuk AT gmail DOT com]

Distributed under the MIT License