stepman

package

v0.0.0-...-9e34962 Latest Latest Go to latest Published: Apr 2, 2024 License: MIT Imports: 19 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bitrise-io/stepman

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func AddRoute(route SteplibRoute) error
func CleanupDanglingLibrary(URI string) error
func CleanupRoute(route SteplibRoute) error
func CreateStepManDirIfNeeded() error
func DownloadStep(collectionURI string, collection models.StepCollectionModel, ...) error
func GenerateFolderAlias() string
func GetAllStepCollectionPath() []string
func GetCacheBaseDir(route SteplibRoute) string
func GetCollectionsDirPath() string
func GetLibraryBaseDirPath(route SteplibRoute) string
func GetSlimStepSpecPath(route SteplibRoute) string
func GetStepCacheDirPath(route SteplibRoute, id, version string) string
func GetStepCollectionDirPath(route SteplibRoute, id, version string) string
func GetStepCollectionSpecPath(route SteplibRoute) string
func GetStepGlobalInfoPath(route SteplibRoute, id string) string
func GetStepSpecPath(route SteplibRoute) string
func GetStepmanDirPath() string
func ParseStepCollection(pth string) (models.StepCollectionModel, error)
func ParseStepDefinition(pth string, validate bool) (models.StepModel, error)
func ParseStepGroupInfo(pth string) (models.StepGroupInfoModel, error)
func ParseStepGroupInfoModel(pth string) (models.StepGroupInfoModel, bool, error)
func ReGenerateLibrarySpec(route SteplibRoute) error
func ReadStepSpec(uri string) (models.StepCollectionModel, error)
func ReadStepVersionInfo(collectionURI, stepID, stepVersionID string) (models.StepVersionModel, error)
func RemoveRoute(route SteplibRoute) error
func RootExistForLibrary(collectionURI string) (bool, error)
func SetupLibrary(libraryURI string, log Logger) error
func UpdateLibrary(libraryURI string, log Logger) (models.StepCollectionModel, error)
func WriteStepSpecToFile(templateCollection models.StepCollectionModel, route SteplibRoute) error
type Logger
type SteplibRoute
- func ReadRoute(uri string) (route SteplibRoute, found bool)
type SteplibRoutes
- func (routes SteplibRoutes) GetRoute(URI string) (route SteplibRoute, found bool)

Constants ¶

View Source

const (
	// StepmanDirname ...
	StepmanDirname = ".stepman"
	// RoutingFilename ...
	RoutingFilename = "routing.json"
	// CollectionsDirname ...
	CollectionsDirname = "step_collections"
)

Variables ¶

This section is empty.

Functions ¶

func AddRoute ¶

func AddRoute(route SteplibRoute) error

AddRoute ...

func CleanupDanglingLibrary ¶

func CleanupDanglingLibrary(URI string) error

CleanupDanglingLibrary ...

func CleanupRoute ¶

func CleanupRoute(route SteplibRoute) error

CleanupRoute ...

func CreateStepManDirIfNeeded ¶

func CreateStepManDirIfNeeded() error

CreateStepManDirIfNeeded ...

func DownloadStep ¶

func DownloadStep(collectionURI string, collection models.StepCollectionModel, id, version, commithash string, log Logger) error

DownloadStep ...

func GenerateFolderAlias ¶

func GenerateFolderAlias() string

GenerateFolderAlias ...

func GetAllStepCollectionPath ¶

func GetAllStepCollectionPath() []string

GetAllStepCollectionPath ...

func GetCacheBaseDir ¶

func GetCacheBaseDir(route SteplibRoute) string

GetCacheBaseDir ...

func GetCollectionsDirPath ¶

func GetCollectionsDirPath() string

GetCollectionsDirPath ...

func GetLibraryBaseDirPath ¶

func GetLibraryBaseDirPath(route SteplibRoute) string

GetLibraryBaseDirPath ...

func GetSlimStepSpecPath ¶

func GetSlimStepSpecPath(route SteplibRoute) string

GetSlimStepSpecPath ...

func GetStepCacheDirPath ¶

func GetStepCacheDirPath(route SteplibRoute, id, version string) string

GetStepCacheDirPath ... Step's Cache dir path, where it's code lives.

func GetStepCollectionDirPath ¶

func GetStepCollectionDirPath(route SteplibRoute, id, version string) string

GetStepCollectionDirPath ... Step's Collection dir path, where it's spec (step.yml) lives.

func GetStepCollectionSpecPath ¶

func GetStepCollectionSpecPath(route SteplibRoute) string

GetStepCollectionSpecPath Location of steplib.yml of the collection marked by this route

func GetStepGlobalInfoPath ¶

func GetStepGlobalInfoPath(route SteplibRoute, id string) string

GetStepGlobalInfoPath ...

func GetStepSpecPath ¶

func GetStepSpecPath(route SteplibRoute) string

GetStepSpecPath ...

func GetStepmanDirPath ¶

func GetStepmanDirPath() string

GetStepmanDirPath ...

func ParseStepCollection ¶

func ParseStepCollection(pth string) (models.StepCollectionModel, error)

ParseStepCollection ...

func ParseStepDefinition ¶

func ParseStepDefinition(pth string, validate bool) (models.StepModel, error)

ParseStepDefinition ...

func ParseStepGroupInfo ¶

func ParseStepGroupInfo(pth string) (models.StepGroupInfoModel, error)

ParseStepGroupInfo ...

func ParseStepGroupInfoModel ¶

func ParseStepGroupInfoModel(pth string) (models.StepGroupInfoModel, bool, error)

ParseStepGroupInfoModel ...

func ReGenerateLibrarySpec ¶

func ReGenerateLibrarySpec(route SteplibRoute) error

ReGenerateLibrarySpec ...

func ReadStepSpec ¶

func ReadStepSpec(uri string) (models.StepCollectionModel, error)

ReadStepSpec ...

func ReadStepVersionInfo ¶

func ReadStepVersionInfo(collectionURI, stepID, stepVersionID string) (models.StepVersionModel, error)

ReadStepVersionInfo ...

func RemoveRoute ¶

func RemoveRoute(route SteplibRoute) error

RemoveRoute ...

func RootExistForLibrary ¶

func RootExistForLibrary(collectionURI string) (bool, error)

RootExistForLibrary ...

func SetupLibrary ¶

func SetupLibrary(libraryURI string, log Logger) error

SetupLibrary ...

func UpdateLibrary ¶

func UpdateLibrary(libraryURI string, log Logger) (models.StepCollectionModel, error)

UpdateLibrary ...

func WriteStepSpecToFile ¶

func WriteStepSpecToFile(templateCollection models.StepCollectionModel, route SteplibRoute) error

WriteStepSpecToFile ...

Types ¶

type Logger ¶

type Logger interface {
	Warnf(format string, v ...interface{})
}

Logger ...

type SteplibRoute ¶

type SteplibRoute struct {
	SteplibURI  string
	FolderAlias string
}

SteplibRoute ...

func ReadRoute ¶

func ReadRoute(uri string) (route SteplibRoute, found bool)

ReadRoute ...

type SteplibRoutes ¶

type SteplibRoutes []SteplibRoute

SteplibRoutes ...

func (SteplibRoutes) GetRoute ¶

func (routes SteplibRoutes) GetRoute(URI string) (route SteplibRoute, found bool)

GetRoute ...

Source Files ¶

View all Source files

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