circler v0.1.0 Circler.Project

Functions for retrieving information about projects.

Link to this section Summary

Types

t()

Functions

list_all(client)

List of all the projects you’re following on CircleCI, with build information organized by branch.

Example

new(type, username, name)

Create a Project struct with type, username and project name.

Example

project(client, project)

Build summary for each of the last 30 builds for a single git repo.

Example

Link to this section Types

Link to this type t()

t() :: %Circler.Project{name: String.t(), type: String.t(), username: String.t()}

Link to this section Functions

Link to this function list_all(client)

list_all(Circler.Client.t()) :: {:atom, any()}

List of all the projects you’re following on CircleCI, with build information organized by branch.

Example

iex> client = Circler.Client.new(“1234567890”) Circler.Project.list_all(client)

More info at: https://circleci.com/docs/api/v1-reference/#summary

Link to this function new(type, username, name)

new(String.t(), String.t(), String.t()) :: t()

Create a Project struct with type, username and project name.

Example

iex> Circler.Project.new(“github”, “codeclimate”, “test-reporter”)

More info at: https://circleci.com/docs/api/v1-reference/#summary

Link to this function project(client, project)

project(Circler.Client.t(), t()) :: {:atom, any()}

Build summary for each of the last 30 builds for a single git repo.

Example

iex> client = Circler.Client.new(“1234567890”) project = Circler.Project.new(“github”, “codeclimate”, “test-reporter”) Circler.Project.project(client, project)

More info at: https://circleci.com/docs/api/v1-reference/#summary