environment

Documentation

Index

• Constants
• func ForceGeneration() bool
• func GetAccessToken() string
• func GetBaseDir() string
• func GetBranchName() string
• func GetCliOutput() string
• func GetDocsLanguages() string
• func GetFeatureBranch() string
• func GetGPGFingerprint() string
• func GetGithubOIDCRequestToken() string
• func GetGithubOIDCRequestURL() string
• func GetGithubServerURL() string
• func GetInvokeTime() time.Time
• func GetLanguages() string
• func GetMaxSuggestions() string
• func GetMaxValidationErrors() (int, error)
• func GetMaxValidationWarnings() (int, error)
• func GetOpenAPIDocAuthHeader() string
• func GetOpenAPIDocAuthToken() string
• func GetOpenAPIDocLocation() string
• func GetOpenAPIDocOutput() string
• func GetOpenAPIDocs() string
• func GetOverlayDocs() string
• func GetPinnedSpeakeasyVersion() string
• func GetPnpmVersion() string
• func GetPoetryVersion() string
• func GetRef() string
• func GetRepo() string
• func GetSDKChangelog() string
• func GetSignedCommits() bool
• func GetSourceBranch() string
• func GetTargetBaseBranch() string
• func GetUvVersion() string
• func GetWorkflowEventLabelName() string
• func GetWorkflowEventPayloadPath() string
• func GetWorkflowName() string
• func GetWorkingDirectory() string
• func GetWorkspace() string
• func IsDebugMode() bool
• func IsDocsGeneration() bool
• func IsMainBranch(branch string) bool
• func IsTestMode() bool
• func PushCodeSamplesOnly() bool
• func RegistryTags() string
• func SanitizeBranchName(branch string) string
• func SetCLIVersionToUse(version string) error
• func SetVersion() string
• func ShouldOutputTests() bool
• func SkipCompile() bool
• func SkipTesting() bool
• func SpeakeasyEnvVars() []string
• func SpecifiedCodeSamplesTargets() []string
• func SpecifiedSources() []string
• func SpecifiedTarget() string
• type Action
  • func GetAction() Action
• type Mode
  • func GetMode() Mode

Constants

const (
	DefaultMaxValidationWarnings = 1000
	DefaultMaxValidationErrors   = 1000
)

Functions

func ForceGeneration

func ForceGeneration() bool

func GetAccessToken

func GetAccessToken() string

func GetBaseDir

func GetBaseDir() string

func GetBranchName

func GetBranchName() string

func GetCliOutput

func GetCliOutput() string

func GetDocsLanguages

func GetDocsLanguages() string

func GetFeatureBranch

func GetFeatureBranch() string

func GetGPGFingerprint

func GetGPGFingerprint() string

func GetGithubOIDCRequestToken

func GetGithubOIDCRequestToken() string

func GetGithubOIDCRequestURL

func GetGithubOIDCRequestURL() string

func GetGithubServerURL

func GetGithubServerURL() string

func GetInvokeTime

func GetInvokeTime() time.Time

func GetLanguages

func GetLanguages() string

func GetMaxSuggestions

func GetMaxSuggestions() string

func GetMaxValidationErrors

func GetMaxValidationErrors() (int, error)

func GetMaxValidationWarnings

func GetMaxValidationWarnings() (int, error)

func GetOpenAPIDocAuthHeader

func GetOpenAPIDocAuthHeader() string

func GetOpenAPIDocAuthToken

func GetOpenAPIDocAuthToken() string

func GetOpenAPIDocLocation

func GetOpenAPIDocLocation() string

func GetOpenAPIDocOutput

func GetOpenAPIDocOutput() string

func GetOpenAPIDocs

func GetOpenAPIDocs() string

func GetOverlayDocs

func GetOverlayDocs() string

func GetPinnedSpeakeasyVersion

func GetPinnedSpeakeasyVersion() string

func GetPnpmVersion

func GetPnpmVersion() string

func GetPoetryVersion

func GetPoetryVersion() string

func GetRef

func GetRef() string

func GetRepo

func GetRepo() string

func GetSDKChangelog

func GetSDKChangelog() string

func GetSignedCommits

func GetSignedCommits() bool

func GetSourceBranch

func GetSourceBranch() string

GetSourceBranch returns the source branch that triggered the generation

func GetTargetBaseBranch

func GetTargetBaseBranch() string

GetTargetBaseBranch returns the branch that PRs should target

func GetUvVersion

func GetUvVersion() string

func GetWorkflowEventLabelName

func GetWorkflowEventLabelName() string

func GetWorkflowEventPayloadPath

func GetWorkflowEventPayloadPath() string

func GetWorkflowName

func GetWorkflowName() string

func GetWorkingDirectory

func GetWorkingDirectory() string

func GetWorkspace

func GetWorkspace() string

func IsDebugMode

func IsDebugMode() bool

func IsDocsGeneration

func IsDocsGeneration() bool

func IsMainBranch

func IsMainBranch(branch string) bool

IsMainBranch returns true if the source branch is main or master

func IsTestMode

func IsTestMode() bool

func PushCodeSamplesOnly

func PushCodeSamplesOnly() bool

func RegistryTags

func RegistryTags() string

func SanitizeBranchName

func SanitizeBranchName(branch string) string

SanitizeBranchName sanitizes a branch name for use in generated branch names

func SetCLIVersionToUse

func SetCLIVersionToUse(version string) error

func SetVersion

func SetVersion() string

func ShouldOutputTests

func ShouldOutputTests() bool

func SkipCompile

func SkipCompile() bool

func SkipTesting

func SkipTesting() bool

Enabled if the INPUT_SKIP_TESTING environment variable is set to "true".

func SpeakeasyEnvVars

func SpeakeasyEnvVars() []string

func SpecifiedCodeSamplesTargets

func SpecifiedCodeSamplesTargets() []string

func SpecifiedSources

func SpecifiedSources() []string

func SpecifiedTarget

func SpecifiedTarget() string

Types

type Action

type Action string

const (
	ActionValidate           Action = "validate"
	ActionRunWorkflow        Action = "run-workflow"
	ActionSuggest            Action = "suggest"
	ActionFinalize           Action = "finalize"
	ActionFinalizeSuggestion Action = "finalize-suggestion"
	ActionRelease            Action = "release"
	ActionLog                Action = "log-result"
	ActionPublishEvent       Action = "publish-event"
	ActionTag                Action = "tag"
	ActionTest               Action = "test"
)

func GetAction

func GetAction() Action

type Mode

type Mode string

const (
	ModeDirect Mode = "direct"
	ModePR     Mode = "pr"
	ModeTest   Mode = "test"
)

func GetMode

func GetMode() Mode