project

Documentation

Index

• func GetProjectEnvVars(project *Project, params ProjectEnvVarParams, telemetryEnabled bool) map[string]string
• func GetProjectHostname(workspaceId string, projectName string) string
• type FileStatus
• type GitStatus
• type Project
• type ProjectEnvVarParams
• type ProjectInfo
• type ProjectState
• type Status

Functions

func GetProjectEnvVars

func GetProjectEnvVars(project *Project, params ProjectEnvVarParams, telemetryEnabled bool) map[string]string

func GetProjectHostname

func GetProjectHostname(workspaceId string, projectName string) string

Types

type FileStatus

type FileStatus struct {
	Name     string `json:"name" validate:"required"`
	Extra    string `json:"extra" validate:"required"`
	Staging  Status `json:"staging" validate:"required"`
	Worktree Status `json:"worktree" validate:"required"`

} // @name FileStatus

type GitStatus

type GitStatus struct {
	CurrentBranch   string        `json:"currentBranch" validate:"required"`
	Files           []*FileStatus `json:"fileStatus" validate:"required"`
	BranchPublished bool          `json:"branchPublished" validate:"optional"`
	Ahead           int           `json:"ahead" validate:"optional"`
	Behind          int           `json:"behind" validate:"optional"`

} // @name GitStatus

type Project

type Project struct {
	Name                string                     `json:"name" validate:"required"`
	Image               string                     `json:"image" validate:"required"`
	User                string                     `json:"user" validate:"required"`
	BuildConfig         *buildconfig.BuildConfig   `json:"buildConfig,omitempty" validate:"optional"`
	Repository          *gitprovider.GitRepository `json:"repository" validate:"required"`
	EnvVars             map[string]string          `json:"envVars" validate:"required"`
	WorkspaceId         string                     `json:"workspaceId" validate:"required"`
	ApiKey              string                     `json:"-"`
	Target              string                     `json:"target" validate:"required"`
	State               *ProjectState              `json:"state,omitempty" validate:"optional"`
	GitProviderConfigId *string                    `json:"gitProviderConfigId,omitempty" validate:"optional"`

} // @name Project

type ProjectEnvVarParams

type ProjectEnvVarParams struct {
	ApiUrl        string
	ServerUrl     string
	ServerVersion string
	ClientId      string
}

type ProjectInfo

type ProjectInfo struct {
	Name             string `json:"name" validate:"required"`
	Created          string `json:"created" validate:"required"`
	IsRunning        bool   `json:"isRunning" validate:"required"`
	ProviderMetadata string `json:"providerMetadata,omitempty" validate:"optional"`
	WorkspaceId      string `json:"workspaceId" validate:"required"`

} // @name ProjectInfo

type ProjectState

type ProjectState struct {
	UpdatedAt string     `json:"updatedAt" validate:"required"`
	Uptime    uint64     `json:"uptime" validate:"required"`
	GitStatus *GitStatus `json:"gitStatus" validate:"required"`

} // @name ProjectState

type Status

type Status string // @name Status

Status status code of a file in the Worktree

const (
	Unmodified         Status = "Unmodified"
	Untracked          Status = "Untracked"
	Modified           Status = "Modified"
	Added              Status = "Added"
	Deleted            Status = "Deleted"
	Renamed            Status = "Renamed"
	Copied             Status = "Copied"
	UpdatedButUnmerged Status = "Updated but unmerged"
)