api

Documentation

Index

• func EnvEndpointHost() (string, string)
• func GraphQLServerAddress(endpoint string, host string) (string, error)
• func OrbID(ctx context.Context, logger *logger.Logger, namespace string, orb string) (string, error)
• func OrbLatestVersion(ctx context.Context, logger *logger.Logger, namespace string, orb string) (string, error)
• func OrbSource(ctx context.Context, logger *logger.Logger, orbRef string) (string, error)
• type ConfigResponse
  • func ConfigQuery(ctx context.Context, logger *logger.Logger, configPath string) (*ConfigResponse, error)
  • func OrbQuery(ctx context.Context, logger *logger.Logger, configPath string) (*ConfigResponse, error)
• type CreateNamespaceResponse
  • func CreateNamespace(ctx context.Context, logger *logger.Logger, name string, ...) (*CreateNamespaceResponse, error)
• type CreateOrbResponse
  • func CreateOrb(ctx context.Context, logger *logger.Logger, namespace string, name string) (*CreateOrbResponse, error)
• type GQLResponseErrors
  • func (response GQLResponseErrors) ToError() error
• type IntrospectionResponse
  • func IntrospectionQuery(ctx context.Context, logger *logger.Logger) (*IntrospectionResponse, error)
• type Orb
  • func OrbIncrementVersion(ctx context.Context, logger *logger.Logger, configPath string, ...) (*Orb, error)
  • func OrbPromote(ctx context.Context, logger *logger.Logger, namespace string, orb string, ...) (*Orb, error)
  • func OrbPublishByID(ctx context.Context, logger *logger.Logger, configPath string, orbID string, ...) (*Orb, error)
  • func (orb Orb) String() string
• type OrbCollection
  • func ListNamespaceOrbs(ctx context.Context, logger *logger.Logger, namespace string) (*OrbCollection, error)
  • func ListOrbs(ctx context.Context, logger *logger.Logger, uncertified bool) (*OrbCollection, error)
  • func (orbCollection OrbCollection) String() string
• type OrbPromoteResponse
• type OrbPublishResponse
• type OrbVersion
• type WhoamiResponse
  • func WhoamiQuery(ctx context.Context, logger *logger.Logger) (*WhoamiResponse, error)

Functions

func EnvEndpointHost

func EnvEndpointHost() (string, string)

EnvEndpointHost pulls the endpoint and host values from viper

func GraphQLServerAddress

func GraphQLServerAddress(endpoint string, host string) (string, error)

GraphQLServerAddress returns the full address to CircleCI GraphQL API server

func OrbID

func OrbID(ctx context.Context, logger *logger.Logger, namespace string, orb string) (string, error)

OrbID fetches an orb returning the ID

func OrbLatestVersion

func OrbLatestVersion(ctx context.Context, logger *logger.Logger, namespace string, orb string) (string, error)

OrbLatestVersion finds the latest published version of an orb and returns it. If it doesn't find a version, it will return 0.0.0 for the orb's version

func OrbSource

func OrbSource(ctx context.Context, logger *logger.Logger, orbRef string) (string, error)

OrbSource gets the source or an orb

Types

type ConfigResponse

type ConfigResponse struct {
	Valid      bool
	SourceYaml string
	OutputYaml string

	GQLResponseErrors
}

ConfigResponse is a structure that matches the result of the GQL query, so that we can use mapstructure to convert from nested maps to a strongly typed struct.

func ConfigQuery

func ConfigQuery(ctx context.Context, logger *logger.Logger, configPath string) (*ConfigResponse, error)

ConfigQuery calls the GQL API to validate and process config

func OrbQuery

func OrbQuery(ctx context.Context, logger *logger.Logger, configPath string) (*ConfigResponse, error)

OrbQuery validated and processes an orb.

type CreateNamespaceResponse

type CreateNamespaceResponse struct {
	Namespace struct {
		CreatedAt string
		ID        string
	}

	GQLResponseErrors
}

CreateNamespaceResponse type matches the data shape of the GQL response for creating a namespace

func CreateNamespace

func CreateNamespace(ctx context.Context, logger *logger.Logger, name string, organizationName string, organizationVcs string) (*CreateNamespaceResponse, error)

CreateNamespace creates (reserves) a namespace for an organization

type CreateOrbResponse

type CreateOrbResponse struct {
	Orb Orb
	GQLResponseErrors
}

CreateOrbResponse type matches the data shape of the GQL response for creating an orb

func CreateOrb

func CreateOrb(ctx context.Context, logger *logger.Logger, namespace string, name string) (*CreateOrbResponse, error)

CreateOrb creates (reserves) an orb within a namespace

type GQLResponseErrors

type GQLResponseErrors struct {
	Errors []struct {
		Message string
	}
}

GQLResponseErrors is a slice of errors returned by the GraphQL server. Each error message is a key-value pair with the structure "Message: string"

func (GQLResponseErrors) ToError

func (response GQLResponseErrors) ToError() error

ToError returns all GraphQL errors for a single response concatenated, or nil.

type IntrospectionResponse

type IntrospectionResponse struct {
	Schema struct {
		MutationType struct {
			Name string
		}
		QueryType struct {
			Name string
		}
		Types []struct {
			Description string
			Fields      []struct {
				Name string
			}
			Kind string
			Name string
		}
	} `json:"__schema"`
}

IntrospectionResponse matches the result from making an introspection query

func IntrospectionQuery

func IntrospectionQuery(ctx context.Context, logger *logger.Logger) (*IntrospectionResponse, error)

IntrospectionQuery makes a query on the API asking for bits of the schema This query isn't intended to get the entire schema, there are better tools for that.

type Orb

type Orb struct {
	ID        string `json:"-"`
	Name      string `json:"name"`
	Namespace string `json:"-"`
	CreatedAt string `json:"-"`

	Source string `json:"-"`
	// Avoid "Version" since there is a "version" key in the orb source referring
	// to the orb schema version
	HighestVersion string              `json:"version"`
	Version        string              `json:"-"`
	Commands       map[string]struct{} `json:"-"`
	Jobs           map[string]struct{} `json:"-"`
	Executors      map[string]struct{} `json:"-"`
	Versions       []OrbVersion        `json:"versions"`
}

Orb is a struct for containing the yaml-unmarshaled contents of an orb

func OrbIncrementVersion

func OrbIncrementVersion(ctx context.Context, logger *logger.Logger, configPath string, namespace string, orb string, segment string) (*Orb, error)

OrbIncrementVersion accepts an orb and segment to increment the orb.

func OrbPromote

func OrbPromote(ctx context.Context, logger *logger.Logger, namespace string, orb string, label string, segment string) (*Orb, error)

OrbPromote takes an orb and a development version and increments a semantic release with the given segment.

func OrbPublishByID

func OrbPublishByID(ctx context.Context, logger *logger.Logger,
	configPath string, orbID string, orbVersion string) (*Orb, error)

OrbPublishByID publishes a new version of an orb by id

func (Orb) String

func (orb Orb) String() string

String returns a text representation of the Orb contents, intended for direct human use rather than machine use. This function will exclude orb source and orbs without any versions in its returned string.

type OrbCollection

type OrbCollection struct {
	Orbs      []Orb  `json:"orbs"`
	Namespace string `json:"namespace,omitempty"`
}

OrbCollection is a container type for multiple orbs to share formatting functions on them.

func ListNamespaceOrbs

func ListNamespaceOrbs(ctx context.Context, logger *logger.Logger, namespace string) (*OrbCollection, error)

ListNamespaceOrbs queries the API to find all orbs belonging to the given namespace. Returns a collection of Orb objects containing their relevant data. Logs request and parse errors to the supplied logger.

func ListOrbs

func ListOrbs(ctx context.Context, logger *logger.Logger, uncertified bool) (*OrbCollection, error)

ListOrbs queries the API to find all orbs. Returns a collection of Orb objects containing their relevant data. Logs request and parse errors to the supplied logger.

func (OrbCollection) String

func (orbCollection OrbCollection) String() string

String returns a text representation of all Orbs, intended for direct human use rather than machine use.

type OrbPromoteResponse

type OrbPromoteResponse struct {
	Orb Orb
	GQLResponseErrors
}

The OrbPromoteResponse type matches the data shape of the GQL response for promoting an orb.

type OrbPublishResponse

type OrbPublishResponse struct {
	Orb Orb
	GQLResponseErrors
}

The OrbPublishResponse type matches the data shape of the GQL response for publishing an orb.

type OrbVersion

type OrbVersion struct {
	Version string `json:"version"`
	Source  string `json:"source"`
}

OrbVersion represents a single orb version and its source

type WhoamiResponse

type WhoamiResponse struct {
	Me struct {
		Name string
	}

	GQLResponseErrors
}

WhoamiResponse type matches the data shape of the GQL response for the current user

func WhoamiQuery

func WhoamiQuery(ctx context.Context, logger *logger.Logger) (*WhoamiResponse, error)

WhoamiQuery returns the result of querying the `/me` endpoint of the API