Help us shape the future of Go! Take the 2026 Go Developer Survey

provider

package
v1.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 30, 2026 License: MIT Imports: 1 Imported by: 0

Documentation

Overview

Package provider declares the integrations a repository can be connected to CircleCI through, and how to recognise one from a git remote.

Adding an integration means adding one entry to the registry below. Nothing else in the CLI names an integration: the connection flow, repository resolution, and the pipeline and trigger writes all take a Provider and read what they need from it.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Provider

type Provider struct {
	// Name is the value the API uses in provider fields and filters.
	Name string
	// Short names the integration in progress output, e.g. "GitHub App" in
	// "Waiting for GitHub App installation".
	Short string
	// Install is the subject of the install prompt, e.g. "the CircleCI GitHub
	// App" in "Install the CircleCI GitHub App to connect your repository".
	Install string
	// Hosts are the git remote hosts whose repositories belong to this
	// integration. A host matches when it equals one of these or is a subdomain
	// of it, so enterprise and regional hosts resolve without new entries.
	Hosts []string
	// InstalledPath is the app page an install returns the browser to, relative to
	// the app URL. It confirms the install and points the user back at their
	// terminal, so it names the integration the user just installed.
	InstalledPath string
}

Provider describes an integration onboard can connect a repository through.

func ForHost

func ForHost(host string) (Provider, bool)

ForHost returns the integration that owns repositories on host, and whether one was found. Matching is case-insensitive and ignores a port.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL