workspacepaths

package

v0.3.0 Latest Latest Go to latest Published: Jun 19, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Details

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

Repository

github.com/Airgap-Castaways/deck

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func AllowedAuthoringPathPatterns() []string
func ApplyStateDir(root string) string
func ApplyStateFile(root string, name string) string
func CanonicalApplyWorkflowPath(root string) string
func CanonicalPrepareWorkflowPath(root string) string
func CanonicalPreparedRoots() []string
func CanonicalVarsPath(root string) string
func CanonicalWorkflowPaths() []string
func DefaultPreparedRoot(root string) string
func IsAllowedAuthoringPath(path string) bool
func IsCanonicalPrepareWorkflowPath(path string) bool
func IsCanonicalPreparedPath(rel string) bool
func IsCanonicalVarsWorkflowPath(path string) bool
func IsComponentAuthoringPath(path string) bool
func IsComponentWorkflowPath(path string) bool
func IsPathUnderWorkflowSubdir(path string, subdir string) bool
func IsPreparedFilePath(rel string) bool
func IsPreparedImagePath(rel string) bool
func IsPreparedManifestPathUnderRoot(rel string, root string) bool
func IsPreparedPackagePath(rel string) bool
func IsPreparedPathUnderRoot(rel string, root string) bool
func IsScenarioAuthoringPath(path string) bool
func IsScenarioWorkflowPath(path string) bool
func IsWorkflowAuthoringPath(path string) bool
func LocateWorkflowTreeRoot(workflowPath string) (string, error)
func PreparedRootPath(root string) string
func WorkflowComponentsPath(root string) string
func WorkflowPath(root string, rel string) string
func WorkflowRootPath(root string) string
func WorkflowScenariosPath(root string) string

Constants ¶

View Source

const (
	WorkflowRootDir             = "workflows"
	WorkflowScenariosDir        = "scenarios"
	WorkflowComponentsDir       = "components"
	WorkflowIndexRel            = "index.json"
	WorkflowIndexPathRel        = WorkflowRootDir + "/" + WorkflowIndexRel
	CanonicalScenariosDir       = WorkflowRootDir + "/" + WorkflowScenariosDir
	CanonicalComponentsDir      = WorkflowRootDir + "/" + WorkflowComponentsDir
	CanonicalScenariosPrefix    = CanonicalScenariosDir + "/"
	CanonicalComponentsPrefix   = CanonicalComponentsDir + "/"
	CanonicalPrepareWorkflowRel = "prepare.yaml"
	CanonicalApplyWorkflowRel   = "scenarios/apply.yaml"
	WorkflowVarsRel             = "vars.yaml"
	CanonicalPrepareWorkflow    = WorkflowRootDir + "/" + CanonicalPrepareWorkflowRel
	CanonicalApplyWorkflow      = WorkflowRootDir + "/" + CanonicalApplyWorkflowRel
	CanonicalVarsWorkflow       = WorkflowRootDir + "/" + WorkflowVarsRel
	PreparedDirRel              = "outputs"
	PreparedFilesRoot           = "files"
	PreparedPackagesRoot        = "packages"
	PreparedImagesRoot          = "images"
	PreparedBinRoot             = "bin"
	DeckDirRel                  = ".deck"
	WorkspaceStateDirRel        = "state"
	ApplyStateDirRel            = "apply"
)

Variables ¶

This section is empty.

Functions ¶

func AllowedAuthoringPathPatterns ¶ added in v0.2.1

func AllowedAuthoringPathPatterns() []string

func ApplyStateDir ¶ added in v0.2.9

func ApplyStateDir(root string) string

func ApplyStateFile ¶ added in v0.2.9

func ApplyStateFile(root string, name string) string

func CanonicalApplyWorkflowPath ¶

func CanonicalApplyWorkflowPath(root string) string

func CanonicalPrepareWorkflowPath ¶

func CanonicalPrepareWorkflowPath(root string) string

func CanonicalPreparedRoots ¶ added in v0.2.0

func CanonicalPreparedRoots() []string

func CanonicalVarsPath ¶

func CanonicalVarsPath(root string) string

func CanonicalWorkflowPaths ¶ added in v0.2.2

func CanonicalWorkflowPaths() []string

func DefaultPreparedRoot ¶

func DefaultPreparedRoot(root string) string

func IsAllowedAuthoringPath ¶ added in v0.2.1

func IsAllowedAuthoringPath(path string) bool

func IsCanonicalPrepareWorkflowPath ¶ added in v0.2.2

func IsCanonicalPrepareWorkflowPath(path string) bool

func IsCanonicalPreparedPath ¶ added in v0.2.0

func IsCanonicalPreparedPath(rel string) bool

func IsCanonicalVarsWorkflowPath ¶ added in v0.2.2

func IsCanonicalVarsWorkflowPath(path string) bool

func IsComponentAuthoringPath ¶ added in v0.2.2

func IsComponentAuthoringPath(path string) bool

func IsComponentWorkflowPath ¶

func IsComponentWorkflowPath(path string) bool

func IsPathUnderWorkflowSubdir ¶

func IsPathUnderWorkflowSubdir(path string, subdir string) bool

func IsPreparedFilePath ¶ added in v0.2.3

func IsPreparedFilePath(rel string) bool

func IsPreparedImagePath ¶ added in v0.2.3

func IsPreparedImagePath(rel string) bool

func IsPreparedManifestPathUnderRoot ¶ added in v0.2.3

func IsPreparedManifestPathUnderRoot(rel string, root string) bool

func IsPreparedPackagePath ¶ added in v0.2.3

func IsPreparedPackagePath(rel string) bool

func IsPreparedPathUnderRoot ¶ added in v0.2.0

func IsPreparedPathUnderRoot(rel string, root string) bool

func IsScenarioAuthoringPath ¶ added in v0.2.2

func IsScenarioAuthoringPath(path string) bool

func IsScenarioWorkflowPath ¶

func IsScenarioWorkflowPath(path string) bool

func IsWorkflowAuthoringPath ¶ added in v0.2.3

func IsWorkflowAuthoringPath(path string) bool

func LocateWorkflowTreeRoot ¶

func LocateWorkflowTreeRoot(workflowPath string) (string, error)

func PreparedRootPath ¶ added in v0.2.3

func PreparedRootPath(root string) string

func WorkflowComponentsPath ¶

func WorkflowComponentsPath(root string) string

func WorkflowPath ¶

func WorkflowPath(root string, rel string) string

func WorkflowRootPath ¶

func WorkflowRootPath(root string) string

func WorkflowScenariosPath ¶

func WorkflowScenariosPath(root string) string

Types ¶

This section is empty.

Source Files ¶

View all Source files

paths.go

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