workflow

package

Go to main page

Versions in this module

v1

v1.43.1

Dec 3, 2025

v1.43.0

Dec 3, 2025

v1.42.0

Nov 5, 2025

v1.41.0

Nov 2, 2025

Changes in this version

type Document

+ func (Document) PrepareJSONSchema(schema *jsg.Schema) error

v1.40.0

Oct 30, 2025

v1.39.0

Oct 29, 2025

v1.38.1

Oct 27, 2025

v1.38.0

Oct 27, 2025

v1.37.1

Oct 27, 2025

v1.37.0

Oct 22, 2025

v1.36.2

Oct 27, 2025

Changes in this version

type Overlay

+ func (Overlay) PrepareJSONSchema(schema *jsg.Schema) error

type Transformation

+ JQSymbolicExecution *bool

type Version

+ func (Version) PrepareJSONSchema(schema *jsg.Schema) error

v1.36.1

Oct 17, 2025

v1.36.0

Oct 9, 2025

v1.35.0

Sep 26, 2025

Changes in this version

type Workflow

+ func (w *Workflow) Merge(other *Workflow)

v1.34.0

Sep 26, 2025

Changes in this version

type CodeSamples

+ Disabled *bool

+ func (c CodeSamples) Enabled() bool

type Target

+ func (t Target) CodeSamplesEnabled() bool

v1.33.0

Sep 24, 2025

Changes in this version

+ type Dependent struct

+ CloneCommand string

+ Location string

+ func (r Dependent) Validate() error

type Workflow

+ Dependents map[string]Dependent

v1.32.1

Sep 24, 2025

v1.32.0

Sep 24, 2025

v1.31.9

Sep 19, 2025

v1.31.8

Sep 9, 2025

v1.31.7

Sep 9, 2025

v1.31.6

Sep 9, 2025

v1.31.5

Sep 8, 2025

v1.31.4

Sep 8, 2025

v1.31.3

Aug 4, 2025

v1.31.2

Jul 14, 2025

v1.31.1

Jun 23, 2025

v1.31.0

Jun 2, 2025

v1.30.21

May 27, 2025

v1.30.20

May 19, 2025

v1.30.19

May 12, 2025

v1.30.18

May 7, 2025

v1.30.17

Apr 28, 2025

v1.30.16

Apr 26, 2025

v1.30.15

Apr 25, 2025

v1.30.14

Apr 24, 2025

v1.30.13

Apr 2, 2025

v1.30.12

Mar 19, 2025

v1.30.11

Mar 14, 2025

v1.30.10

Mar 9, 2025

v1.30.8

Mar 6, 2025

v1.30.7

Feb 28, 2025

v1.30.6

Feb 17, 2025

v1.30.5

Feb 17, 2025

v1.30.4

Feb 16, 2025

v1.30.3

Feb 12, 2025

v1.30.2

Feb 12, 2025

v1.30.1

Jan 17, 2025

v1.30.0

Jan 7, 2025

v1.29.4

Jan 3, 2025

v1.29.3

Dec 20, 2024

v1.29.2

Dec 20, 2024

Changes in this version

+ type NormalizeOptions struct

+ PrefixItems *bool

type Transformation

+ Format *bool

+ Normalize *NormalizeOptions

v1.29.1

Nov 26, 2024

v1.29.0

Nov 26, 2024

v1.28.1

Nov 26, 2024

Changes in this version

+ type MockServer struct

+ Enabled *bool

type Target

+ Testing *Testing

+ type Testing struct

+ Enabled *bool

+ MockServer *MockServer

v1.28.0

Nov 11, 2024

v1.27.4

Nov 8, 2024

v1.27.3

Nov 7, 2024

v1.27.2

Nov 5, 2024

Changes in this version

type Source

+ func (s Source) IsSingleInput() bool

v1.27.1

Nov 5, 2024

Changes in this version

type Source

+ func (s Source) GetTempTransformLocation() string

v1.27.0

Nov 5, 2024

Changes in this version

+ type FilterOperationsOptions struct

+ Exclude *bool

+ Include *bool

+ Operations string

+ func (f FilterOperationsOptions) ParseOperations() []string

type Source

+ Transformations []Transformation

+ type Transformation struct

+ Cleanup *bool

+ FilterOperations *FilterOperationsOptions

+ RemoveUnused *bool

+ func (t Transformation) Validate() error

v1.26.0

Nov 4, 2024

v1.25.0

Nov 4, 2024

v1.24.0

Sep 24, 2024

v1.23.8

Oct 30, 2024

v1.23.7

Oct 23, 2024

Changes in this version

+ var SupportedLanguagesUsageSnippets = []string

type CodeSamples

+ Blocking *bool

type Workflow

+ func (w Workflow) Migrate() Workflow

+ func (w Workflow) MigrateNoTelemetry() Workflow

v1.23.6

Oct 9, 2024

v1.23.5

Oct 8, 2024

v1.23.4

Oct 4, 2024

v1.23.3

Sep 27, 2024

v1.23.2

Sep 24, 2024

v1.23.1

Sep 18, 2024

v1.23.0

Sep 16, 2024

Changes in this version

type CodeSamples

+ LabelOverride *CodeSamplesLabelOverride

+ LangOverride *string

+ type CodeSamplesLabelOverride struct

+ FixedValue *string

+ Omit *bool

v1.22.0

Sep 13, 2024

Changes in this version

+ type LocationString string

+ func (l LocationString) Reference() string

+ func (l LocationString) Resolve() string

v1.21.1

Sep 12, 2024

v1.21.0

Sep 9, 2024

v1.20.0

Sep 5, 2024

v1.19.0

Aug 15, 2024

v1.18.0

Aug 15, 2024

v1.17.1

Aug 12, 2024

v1.17.0

Jul 30, 2024

v1.16.2

Jul 11, 2024

Changes in this version

type CodeSamples

+ Style *string

v1.16.1

Jul 9, 2024

v1.16.0

Jul 8, 2024

v1.15.4

Jul 1, 2024

Changes in this version

type FallbackCodeSamples

+ func (f FallbackCodeSamples) Validate() error

type Overlay

+ func (o Overlay) Validate() error

v1.15.3

Jul 1, 2024

Changes in this version

type Overlay

+ func (o *Overlay) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (o Overlay) MarshalYAML() (interface{}, error)

v1.15.2

Jun 30, 2024

v1.15.1

Jun 30, 2024

Changes in this version

+ type FallbackCodeSamples struct

+ FallbackCodeSamplesLanguage string

+ type Overlay struct

+ Document *Document

+ FallbackCodeSamples *FallbackCodeSamples

v1.15.0

Jun 20, 2024

v1.14.12

Jun 19, 2024

v1.14.11

Jun 17, 2024

v1.14.10

Jun 14, 2024

v1.14.10-alpha

Jun 15, 2024

v1.14.9

Jun 14, 2024

v1.14.8

Jun 14, 2024

v1.14.7

Jun 11, 2024

v1.14.6

Jun 7, 2024

Changes in this version

type TargetLock

+ CodeSamplesBlobDigest string

+ CodeSamplesNamespace string

+ CodeSamplesRevisionDigest string

v1.14.5

Jun 4, 2024

v1.14.4

May 31, 2024

Changes in this version

type Publishing

+ Terraform *Terraform

+ type Terraform struct

+ GPGPassPhrase string

+ GPGPrivateKey string

v1.14.3

May 23, 2024

Changes in this version

type CodeSamples

+ Registry *SourceRegistry

v1.14.2

May 1, 2024

v1.14.1

Apr 30, 2024

v1.14.0

Apr 26, 2024

v1.13.0

Apr 25, 2024

Changes in this version

type Source

+ Registry *SourceRegistry

+ type SourceRegistry struct

+ Location SourceRegistryLocation

+ Tags []string

+ func (p *SourceRegistry) ParseRegistryLocation() (string, string, string, error)

+ func (p *SourceRegistry) SetNamespace(namespace string) error

+ func (p SourceRegistry) Validate() error

+ type SourceRegistryLocation string

+ func (n SourceRegistryLocation) Namespace() string

+ func (n SourceRegistryLocation) NamespaceName() string

+ func (n SourceRegistryLocation) String() string

v1.12.0

Apr 23, 2024

Changes in this version

type SpeakeasyRegistryDocument

+ NamespaceName string

+ OrganizationSlug string

+ WorkspaceSlug string

v1.11.7

Apr 22, 2024

Changes in this version

type SourcePublishing

+ func (p *SourcePublishing) ParseRegistryLocation() (string, string, string, error)

v1.11.6

Apr 22, 2024

v1.11.5

Apr 22, 2024

v1.11.4

Apr 19, 2024

v1.11.3

Apr 18, 2024

Changes in this version

type Document

+ func (d Document) GetTempRegistryDir(tempDir string) string

+ func (d Document) IsSpeakeasyRegistry() bool

+ type SpeakeasyRegistryDocument struct

+ NamespaceID string

+ Reference string

+ func ParseSpeakeasyRegistryReference(location string) *SpeakeasyRegistryDocument

v1.11.2

Apr 18, 2024

Changes in this version

type SourceLock

+ SourceBlobDigest string

type TargetLock

+ SourceBlobDigest string

v1.11.1

Apr 17, 2024

Changes in this version

type TargetLock

+ OutLocation string

+ SourceNamespace string

+ SourceRevisionDigest string

v1.11.0

Apr 16, 2024

Changes in this version

+ func SaveLockfile(dir string, lockfile *LockFile) error

+ type LockFile struct

+ Sources map[string]SourceLock

+ SpeakeasyVersion string

+ Targets map[string]TargetLock

+ Workflow Workflow

+ func LoadLockfile(dir string) (*LockFile, error)

+ type SourceLock struct

+ SourceNamespace string

+ SourceRevisionDigest string

+ Tags []string

+ type TargetLock struct

+ GenLockLocation string

+ Source string

v1.10.2

Apr 11, 2024

Changes in this version

type Workflow

+ VersionLocked bool

v1.10.1

Apr 10, 2024

Changes in this version

+ type SourcePublishLocation string

+ func (n SourcePublishLocation) Namespace() string

+ func (n SourcePublishLocation) NamespaceName() string

+ func (n SourcePublishLocation) String() string

+ type SourcePublishing struct

+ Location SourcePublishLocation

+ Tags []string

+ func (p SourcePublishing) SetNamespace(namespace string) error

+ func (p SourcePublishing) Validate() error

+ type Version string

+ func (v Version) String() string

type Workflow

+ SpeakeasyVersion Version

v1.10.0

Apr 10, 2024

Changes in this version

+ type Publish struct

+ Location string

+ Tags []string

+ func (p Publish) Validate() error

type Source

+ Publish *Publish

v1.9.3

Apr 2, 2024

v1.9.2

Mar 29, 2024

v1.9.1

Mar 20, 2024

Changes in this version

type Source

+ Ruleset *string

v1.9.0

Mar 20, 2024

Changes in this version

+ type CodeSamples struct

+ Output string

type Target

+ CodeSamples *CodeSamples

v1.8.1

Mar 19, 2024

v1.8.0

Mar 19, 2024

v1.7.5

Feb 27, 2024

v1.7.4

Feb 27, 2024

Changes in this version

type Java

+ UseSonatypeLegacy bool

v1.7.3

Feb 23, 2024

v1.7.2

Feb 12, 2024

Changes in this version

+ func SanitizeFilePath(path string) string

v1.7.1

Feb 8, 2024

v1.7.0

Feb 8, 2024

v1.6.5

Feb 5, 2024

Changes in this version

type Target

+ func (t Target) IsPublished() bool

v1.6.4

Feb 5, 2024

v1.6.3

Feb 1, 2024

v1.6.2

Feb 1, 2024

v1.6.1

Jan 12, 2024

v1.6.0

Jan 11, 2024

Changes in this version

+ const WorkflowVersion

+ var ErrNotFound = errors.New("could not find workflow.yaml")

+ func GetTempDir() string

+ func Save(dir string, workflow *Workflow) error

+ type Auth struct

+ Header string

+ Secret string

+ type Document struct

+ Auth *Auth

+ Location string

+ func (d Document) GetTempDownloadPath(tempDir string) string

+ func (d Document) IsRemote() bool

+ func (d Document) Validate() error

+ type Java struct

+ GPGPassPhrase string

+ GPGSecretKey string

+ OSSHRPassword string

+ OSSRHUsername string

+ type NPM struct

+ Token string

+ type Nuget struct

+ APIKey string

+ type Packagist struct

+ Token string

+ Username string

+ type Publishing struct

+ Java *Java

+ NPM *NPM

+ Nuget *Nuget

+ Packagist *Packagist

+ PyPi *PyPi

+ RubyGems *RubyGems

+ func (p Publishing) IsPublished(target string) bool

+ func (p Publishing) Validate(target string) error

+ type PyPi struct

+ Token string

+ type RubyGems struct

+ Token string

+ type Source struct

+ Inputs []Document

+ Output *string

+ Overlays []Document

+ func (s Source) GetOutputLocation() (string, error)

+ func (s Source) GetTempMergeLocation() string

+ func (s Source) GetTempOverlayLocation() string

+ func (s Source) Validate() error

+ type Target struct

+ Output *string

+ Publishing *Publishing

+ Source string

+ Target string

+ func (t Target) Validate(supportedLangs []string, sources map[string]Source) error

+ type Workflow struct

+ Sources map[string]Source

+ Targets map[string]Target

+ Version string

+ func Load(dir string) (*Workflow, string, error)

+ func (w Workflow) GetTargetSource(target string) (*Source, string, error)

+ func (w Workflow) Validate(supportLangs []string) error

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