compose

package

v1.3.1 Latest Latest Go to latest Published: Jul 3, 2026 License: MPL-2.0 Imports: 15 Imported by: 0

Details

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

Repository

github.com/devsy-org/devsy

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func LoadDockerComposeProject(ctx context.Context, paths []string, envFiles []string) (*composetypes.Project, error)
type ComposeHelper
- func NewComposeHelper(dockerHelper *docker.DockerHelper) (*ComposeHelper, error)

Constants ¶

View Source

const (
	ProjectLabel = "com.docker.compose.project"
	ServiceLabel = "com.docker.compose.service"
)

Variables ¶

This section is empty.

Functions ¶

func LoadDockerComposeProject ¶

func LoadDockerComposeProject(
	ctx context.Context,
	paths []string,
	envFiles []string,
) (*composetypes.Project, error)

Types ¶

type ComposeHelper ¶

type ComposeHelper struct {
	Command string
	Version string
	Args    []string
	Docker  *docker.DockerHelper
}

func NewComposeHelper ¶

func NewComposeHelper(dockerHelper *docker.DockerHelper) (*ComposeHelper, error)

NewComposeHelper creates a new ComposeHelper instance after detecting whether Docker Compose V2, Podman Compose, or Docker Compose V1 is installed. The detection order depends on the container runtime: Podman runtimes try podman compose first, while Docker/nerdctl runtimes try docker compose V2 first. It returns an error if none are found.

func (*ComposeHelper) FindDevContainer ¶

func (h *ComposeHelper) FindDevContainer(
	ctx context.Context,
	projectName, serviceName string,
) (*config.ContainerDetails, error)

func (*ComposeHelper) FindProjectFiles ¶

func (h *ComposeHelper) FindProjectFiles(
	ctx context.Context,
	projectName string,
) ([]string, error)

func (*ComposeHelper) GetDefaultImage ¶

func (h *ComposeHelper) GetDefaultImage(projectName, serviceName string) (string, error)

func (*ComposeHelper) GetProjectName ¶

func (h *ComposeHelper) GetProjectName(runnerID string) string

func (*ComposeHelper) Remove ¶

func (h *ComposeHelper) Remove(
	ctx context.Context,
	projectName string,
	args []string,
	removeVolumes bool,
) error

func (*ComposeHelper) Run ¶

func (h *ComposeHelper) Run(
	ctx context.Context,
	args []string,
	stdin io.Reader,
	stdout io.Writer,
	stderr io.Writer,
) error

func (*ComposeHelper) Stop ¶

func (h *ComposeHelper) Stop(ctx context.Context, projectName string, args []string) error

Source Files ¶

View all Source files

helper.go

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