package
0.1.31425
Repository: https://github.com/circleci-public/circleci-cli.git
Documentation: pkg.go.dev

# Packages

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

# Functions

AddOrRemoveOrbCategorization adds or removes an orb categorization.
CreateImportedNamespace creates an imported namespace with the provided name.
CreateImportedOrb creates (reserves) an imported orb within the provided namespace.
CreateNamespace creates (reserves) a namespace for an organization.
No description provided by the author
CreateOrb creates (reserves) an orb within a namespace.
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
ListNamespaceOrbs queries the API to find all orbs belonging to the given namespace.
ListNamespaceOrbVersions queries the API to retrieve the orbs belonging to the given namespace.
ListOrbCategories queries the API to find all categories.
ListOrbs queries the API to find all orbs.
NamespaceExists returns a boolean indicating if the provided namespace exists.
Returns a new client satisfying the api.ScheduleInterface interface via the REST API.
OrbCategoryID fetches an orb returning the ID.
OrbExists checks whether an orb exists within the provided namespace and whether it's private.
OrbID fetches an orb returning the ID.
OrbImportVersion publishes a new version of an orb using the provided source and id.
OrbIncrementVersion accepts an orb and segment to increment the orb.
OrbInfo gets the meta-data of an orb.
OrbLatestVersion finds the latest published version of an orb and returns it.
OrbPromoteByName utilizes the given orb's name, namespace, development version, and segment to increment a semantic release.
OrbPublishByName publishes a new version of an orb using the provided orb's name and namespace, returning any error encountered.
OrbSetOrbListStatus sets whether an orb can be listed in the registry or not.
OrbSource gets the source of an orb.
No description provided by the author
WhoamiQuery returns the result of querying the `/me` endpoint of the API.

# Constants

No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
BuildConfigResponse wraps the GQL result of the ConfigQuery.
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.
CreateNamespaceResponse type matches the data shape of the GQL response for creating a namespace.
CreateOrbResponse type matches the data shape of the GQL response for creating an orb.
ErrOrbVersionNotExists is a custom error type that communicates that an orb version was not found.
No description provided by the author
No description provided by the author
GetNamespaceResponse type wraps the GQL response for fetching a namespace.
No description provided by the author
GetOrganizationResponse type wraps the GQL response for fetching an organization and ID.
GQLResponseError is a mapping of the data returned by the GraphQL server of key-value pairs.
ImportNamespaceResponse type matches the data shape of the GQL response for importing a namespace.
ImportOrbResponse type matches the data shape of the GQL response for creating an orb.
No description provided by the author
Namespace represents the contents of a single namespace.
NamespaceOrbResponse type matches the result from GQL.
NamespaceOrbVersionResponse type mat.
Orb is a struct for containing the yaml-unmarshaled contents of an orb.
OrbBase represents the minimum fields we wish to serialize for orbs.
OrbCategoriesForListing is a container type for multiple orb categories for deserializing back into JSON.
No description provided by the author
OrbCategoryIDResponse matches the GQL response for fetching an Orb category's id.
OrbCategoryListResponse type matches the result from GQL.
OrbConfigResponse wraps the GQL result for OrbQuery.
OrbElementParameter represents the yaml-unmarshled contents of a parameter for a command/job/executor.
OrbIDResponse matches the GQL response for fetching an Orb and ID.
The OrbImportVersionResponse type matches the data shape of the GQL response for importing an orb version.
OrbLatestVersionResponse wraps the GQL result of fetching an Orb and latest version.
OrbListResponse type matches the result from GQL.
The OrbPromoteResponse type matches the data shape of the GQL response for promoting an orb.
The OrbPublishResponse type matches the data shape of the GQL response for publishing an orb.
The OrbSetOrbListStatusResponse type matches the data shape of the GQL response for setting the list status of an orb.
OrbsForListing is a container type for multiple orbs that includes the namespace and orbs for deserializing back into JSON.
OrbStatistics represents the data we retrieve for orb usage in the last thirty days.
OrbVersion wraps the GQL result used by OrbSource and OrbInfo.
OrbWithData extends the OrbBase type with additional data used for printing.
RealOrbElement represents the yaml-unmarshled contents of a named element under a command/job/executor.
No description provided by the author
No description provided by the author
Communicates with the CircleCI REST API to ask questions about schedules.
No description provided by the author
WhoamiResponse type matches the data shape of the GQL response for the current user.

# Interfaces

No description provided by the author

# Type aliases

AddOrRemoveOrbCategorizationResponse type matches the data shape of the GQL response for adding or removing an orb categorization.
GQLErrorsCollection is a slice of errors returned by the GraphQL server.
OrbElement implements RealOrbElement interface and allows us to deserialize by hand.
No description provided by the author