modules

Documentation

Index

• func BumpPatch(version string) string
• func Generate(manifest *Manifest) error
• func NextPatch(cfg api.Config, manifest *Manifest) (string, error)
• func Package(manifest *Manifest, version string, addlFiles []string) (string, error)
• func Register(cfg api.Config, manifest *Manifest) (*types.Module, error)
• type Manifest
  • func ManifestFromFile(filename string) (*Manifest, error)
  • func (m Manifest) WriteManifestToFile(filename string) error

Functions

func BumpPatch

func BumpPatch(version string) string

func Generate

func Generate(manifest *Manifest) error

func NextPatch

func NextPatch(cfg api.Config, manifest *Manifest) (string, error)

NextPatch bumps the patch in major.minor.patch from the latest module version

func Package

func Package(manifest *Manifest, version string, addlFiles []string) (string, error)

func Register

func Register(cfg api.Config, manifest *Manifest) (*types.Module, error)

Types

type Manifest

type Manifest struct {
	OrgName       string   `yaml:"org_name" json:"orgName"`
	Name          string   `yaml:"name" json:"name"`
	FriendlyName  string   `yaml:"friendly_name" json:"friendlyName"`
	Description   string   `yaml:"description" json:"description"`
	Category      string   `yaml:"category" json:"category"`
	Subcategory   string   `yaml:"subcategory" json:"subcategory"`
	ProviderTypes []string `yaml:"provider_types" json:"providerTypes"`
	Platform      string   `yaml:"platform" json:"platform"`
	Subplatform   string   `yaml:"subplatform" json:"subplatform"`
	Type          string   `yaml:"type" json:"type"`
	AppCategories []string `yaml:"appCategories" json:"appCategories"`
	IsPublic      bool     `yaml:"is_public" json:"isPublic"`
}

func ManifestFromFile

func ManifestFromFile(filename string) (*Manifest, error)

func (Manifest) WriteManifestToFile

func (m Manifest) WriteManifestToFile(filename string) error