v1

Documentation

Overview

Package v1 is the package containing version 1 of the conmake API

Index

• type Conmakefile
• type Step
• type Workstation

Types

type Conmakefile

type Conmakefile struct {
	//Version is the API version of the used conmake file
	Version string `yaml:"version"`
	//Project is the name of the project
	Project string `yaml:"project"`
	//Steps is a list of 'targets'
	Steps map[string]Step `yaml:"steps,omitempty"`
	//Workstations is a list of 'stations' to run steps on
	Workstations map[string]Workstation `yaml:"workstations,omitempty"`
}

Conmakefile models the YAML Object of a Conmakefile

type Step

type Step struct {
	// Workstation is a reference to a defined workstation or a docker image
	Workstation string `yaml:"workstation"`
	// Command is the command to get executed for this step. If no command is set
	// you have to define a script
	Command string `yaml:"command,omitempty"`
	// A script to execute using /bin/sh. Only used if command is empty
	Script []string `yaml:"script,omitempty"`
}

Step models the YAML Object of a step inside a Conmakefile

type Workstation

type Workstation struct {
	//Base is the base image identifier for the workstation
	Base string `yaml:"base"`
	//Script is the initialization script for the workstation (optional)
	Script []string `yaml:"preparation,omitempty"`
}

Workstation models the YAML Object of a workstation inside a Conmakefile