githubconnections

package

v2.122.0 Latest Latest Go to latest Published: Oct 16, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/OctopusDeploy/go-octopusdeploy

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Connection
type ConnectionStatus
type Installation
type Repository
type Settings
- func GetSettings(client newclient.Client) (*Settings, error)
type UnknownRepository

Constants ¶

View Source

const (
	ConnectionStatusConnected             = ConnectionStatus("Connected")
	ConnectionStatusConnectionNotFound    = ConnectionStatus("ConnectionNotFound")
	ConnectionStatusInstallationNotFound  = ConnectionStatus("InstallationNotFound")
	ConnectionStatusInstallationSuspended = ConnectionStatus("InstallationSuspended")
	ConnectionStatusError                 = ConnectionStatus("Error")
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Connection ¶

type Connection struct {
	ID           string           `json:"Id"`
	Status       ConnectionStatus `json:"Status,omitempty"`
	Installation *Installation    `json:"Installation,omitempty"`
}

Connection represents a GitHub App connection.

type ConnectionStatus ¶

type ConnectionStatus string

ConnectionStatus describes the health of a GitHub App connection.

type Installation ¶

type Installation struct {
	InstallationID   string `json:"InstallationId"`
	AccountID        string `json:"AccountId"`
	AccountLogin     string `json:"AccountLogin"`
	AccountAvatarURL string `json:"AccountAvatarUrl"`
	AccountType      string `json:"AccountType"`
	// AllRepositories is true when the installation can access every repository in the
	// account, false when it is restricted to a selected set.
	AllRepositories bool `json:"AllRepositories"`
}

Installation represents the GitHub App installation backing a connection.

type Repository ¶

type Repository struct {
	RepositoryID   string `json:"RepositoryId"`
	RepositoryName string `json:"RepositoryName"`
	IsAdmin        bool   `json:"IsAdmin"`
	IsPrivate      bool   `json:"IsPrivate"`
	Visibility     string `json:"Visibility"`
	Language       string `json:"Language,omitempty"`
	GitURL         string `json:"GitUrl"`
	DefaultBranch  string `json:"DefaultBranch"`
}

Repository represents a GitHub repository reachable through a GitHub App connection.

type Settings ¶

type Settings struct {
	CanUseGitHubApp   bool `json:"CanUseGitHubApp"`
	CanUseTrustedFlow bool `json:"CanUseTrustedFlow"`
}

Settings represents the server-wide GitHub App settings.

func GetSettings ¶

func GetSettings(client newclient.Client) (*Settings, error)

GetSettings returns the server's GitHub App settings.

type UnknownRepository ¶

type UnknownRepository struct {
	RepositoryID   string `json:"RepositoryId"`
	RepositoryName string `json:"RepositoryName,omitempty"`
}

UnknownRepository represents a repository configured on a connection that has no matching repository returned from GitHub.

Source Files ¶

View all Source files

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