projects

Documentation

Index

• Variables
• func Create(filename string) error
• func GetStatus(id string) string
• func Restart(id string)
• func SetAuth(id, filename string) error
• func Unlink(projectID string) error
• func Validate(projectID string) (err error)
• func ValidateOrCreate(filename string) (created bool, err error)
• type Project
  • func List() (list []Project, err error)
  • func Read(path string) (*Project, error)

Variables

var (
	// ErrProjectNotFound happens when a project.json is not found
	ErrProjectNotFound = errors.New("Project not found")

	// ErrProjectAlreadyExists happens when a Project ID already exists
	ErrProjectAlreadyExists = errors.New("Project already exists")

	// ErrInvalidProjectID happens when a Project ID is invalid
	ErrInvalidProjectID = errors.New("Invalid project ID")
)

Functions

func Create

func Create(filename string) error

Create a project on WeDeploy

func GetStatus

func GetStatus(id string) string

GetStatus gets the status for the project

func Restart

func Restart(id string)

Restart restarts a project

func SetAuth

func SetAuth(id, filename string) error

SetAuth sets a project authentication permissions

func Unlink

func Unlink(projectID string) error

Unlink project

func Validate

func Validate(projectID string) (err error)

Validate project

func ValidateOrCreate

func ValidateOrCreate(filename string) (created bool, err error)

ValidateOrCreate project

Types

type Project

type Project struct {
	ID          string `json:"id"`
	Name        string `json:"name"`
	Domain      string `json:"domain,omitempty"`
	State       string `json:"state,omitempty"`
	Description string `json:"description,omitempty"`
}

Project structure

func List

func List() (list []Project, err error)

List projects

func Read

func Read(path string) (*Project, error)

Read a project directory properties (defined by a project.json on it)