# API Reference (/docs/api)



## Classes [#classes]

* [ActioError](classes/ActioError.mdx)
* [PassRegistry](classes/PassRegistry.mdx)

## Interfaces [#interfaces]

* [ActioConfig](interfaces/ActioConfig.mdx)
* [ActionlintFinding](interfaces/ActionlintFinding.mdx)
* [ActionlintRun](interfaces/ActionlintRun.mdx)
* [BuildSourceMapOptions](interfaces/BuildSourceMapOptions.mdx)
* [Diagnostic](interfaces/Diagnostic.mdx)
* [EmitOptions](interfaces/EmitOptions.mdx)
* [ForEachShareContract](interfaces/ForEachShareContract.mdx)
* [ForEachShareContractEntry](interfaces/ForEachShareContractEntry.mdx)
* [Job](interfaces/Job.mdx)
* [JobDefaultsInternalSnapshot](interfaces/JobDefaultsInternalSnapshot.mdx)
* [JobView](interfaces/JobView.mdx)
* [ModuleResolver](interfaces/ModuleResolver.mdx)
* [NativeDependencyEntry](interfaces/NativeDependencyEntry.mdx)
* [Origin](interfaces/Origin.mdx)
* [ParseContext](interfaces/ParseContext.mdx)
* [ParseContextInternal](interfaces/ParseContextInternal.mdx)
* [Pass](interfaces/Pass.mdx)
* [PermissionsConfig](interfaces/PermissionsConfig.mdx)
* [PinConfig](interfaces/PinConfig.mdx)
* [PinOptions](interfaces/PinOptions.mdx)
* [PinPolicy](interfaces/PinPolicy.mdx)
* [PinResolution](interfaces/PinResolution.mdx)
* [PinTarget](interfaces/PinTarget.mdx)
* [Position](interfaces/Position.mdx)
* [Range](interfaces/Range.mdx)
* [ResolvedModule](interfaces/ResolvedModule.mdx)
* [SourceMap](interfaces/SourceMap.mdx)
* [SourceMapping](interfaces/SourceMapping.mdx)
* [Step](interfaces/Step.mdx)
* [StepView](interfaces/StepView.mdx)
* [SymbolDef](interfaces/SymbolDef.mdx)
* [TaintFacet](interfaces/TaintFacet.mdx)
* [TranspileOptions](interfaces/TranspileOptions.mdx)
* [TranspileResult](interfaces/TranspileResult.mdx)
* [Workflow](interfaces/Workflow.mdx)

## Type Aliases [#type-aliases]

* [ActionlintRunner](type-aliases/ActionlintRunner.mdx)
* [ActioTarget](type-aliases/ActioTarget.mdx)
* [CallTemplateKey](type-aliases/CallTemplateKey.mdx)
* [CoercionCategory](type-aliases/CoercionCategory.mdx)
* [CoercionMode](type-aliases/CoercionMode.mdx)
* [DiagnosticSource](type-aliases/DiagnosticSource.mdx)
* [ExecutorKey](type-aliases/ExecutorKey.mdx)
* [JobDefaultKey](type-aliases/JobDefaultKey.mdx)
* [LintMode](type-aliases/LintMode.mdx)
* [NativeDependencies](type-aliases/NativeDependencies.mdx)
* [ParamType](type-aliases/ParamType.mdx)
* [PassFn](type-aliases/PassFn.mdx)
* [Path](type-aliases/Path.mdx)
* [PermissionsMode](type-aliases/PermissionsMode.mdx)
* [PinCommentStyle](type-aliases/PinCommentStyle.mdx)
* [ScopeLevel](type-aliases/ScopeLevel.mdx)
* [ScopeMap](type-aliases/ScopeMap.mdx)
* [Severity](type-aliases/Severity.mdx)
* [SpawnSync](type-aliases/SpawnSync.mdx)
* [SymbolKind](type-aliases/SymbolKind.mdx)
* [SymbolTable](type-aliases/SymbolTable.mdx)
* [UnusedSymbolsMode](type-aliases/UnusedSymbolsMode.mdx)
* [WorkflowData](type-aliases/WorkflowData.mdx)

## Variables [#variables]

* [ACTIO\_SCHEMA\_URL](variables/ACTIO_SCHEMA_URL.mdx)
* [actioSchemaPath](variables/actioSchemaPath.mdx)
* [annotate](variables/annotate.mdx)
* [ANNOTATE\_ACTION](variables/ANNOTATE_ACTION.mdx)
* [ANNOTATE\_JOB\_ID](variables/ANNOTATE_JOB_ID.mdx)
* [builtinPasses](variables/builtinPasses.mdx)
* [CALL\_TEMPLATE\_KEYS](variables/CALL_TEMPLATE_KEYS.mdx)
* [callTemplates](variables/callTemplates.mdx)
* [COERCION\_CATEGORY\_HINTS](variables/COERCION_CATEGORY_HINTS.mdx)
* [COERCION\_MODES](variables/COERCION_MODES.mdx)
* [dynamicMatrix](variables/dynamicMatrix.mdx)
* [EXECUTOR\_KEYS](variables/EXECUTOR_KEYS.mdx)
* [expandMatrix](variables/expandMatrix.mdx)
* [fallback](variables/fallback.mdx)
* [forEach](variables/forEach.mdx)
* [fragments](variables/fragments.mdx)
* [importPass](variables/importPass.mdx)
* [JOB\_DEFAULT\_KEYS](variables/JOB_DEFAULT_KEYS.mdx)
* [JOB\_DEFAULTS\_SAFE\_SUBSET](variables/JOB_DEFAULTS_SAFE_SUBSET.mdx)
* [jobDefaults](variables/jobDefaults.mdx)
* [lifecycle](variables/lifecycle.mdx)
* [LINT\_MODES](variables/LINT_MODES.mdx)
* [params](variables/params.mdx)
* [permissions](variables/permissions.mdx)
* [retry](variables/retry.mdx)
* [SCHEMA\_MODELINE](variables/SCHEMA_MODELINE.mdx)

## Functions [#functions]

* [actioSchema](functions/actioSchema.mdx)
* [actioSchemaJson](functions/actioSchemaJson.mdx)
* [applyDefaults](functions/applyDefaults.mdx)
* [applyExecutor](functions/applyExecutor.mdx)
* [applyPasses](functions/applyPasses.mdx)
* [applyPins](functions/applyPins.mdx)
* [buildSourceMap](functions/buildSourceMap.mdx)
* [cloneNode](functions/cloneNode.mdx)
* [coercionTrapCategory](functions/coercionTrapCategory.mdx)
* [coercionWarning](functions/coercionWarning.mdx)
* [collectMergeKeyDiagnostics](functions/collectMergeKeyDiagnostics.mdx)
* [collectUnusedSymbolDiagnostics](functions/collectUnusedSymbolDiagnostics.mdx)
* [conservativeTaint](functions/conservativeTaint.mdx)
* [createRegistry](functions/createRegistry.mdx)
* [deepMerge](functions/deepMerge.mdx)
* [defaultActionlintRunner](functions/defaultActionlintRunner.mdx)
* [defineConfig](functions/defineConfig.mdx)
* [deriveNode](functions/deriveNode.mdx)
* [emitYaml](functions/emitYaml.mdx)
* [formatDiagnostic](functions/formatDiagnostic.mdx)
* [formatDiagnostics](functions/formatDiagnostics.mdx)
* [formatGithubAnnotation](functions/formatGithubAnnotation.mdx)
* [generatedHeader](functions/generatedHeader.mdx)
* [lintWorkflowYaml](functions/lintWorkflowYaml.mdx)
* [originOf](functions/originOf.mdx)
* [parseActio](functions/parseActio.mdx)
* [parseUsesRef](functions/parseUsesRef.mdx)
* [permissionsPass](functions/permissionsPass.mdx)
* [pinCommentText](functions/pinCommentText.mdx)
* [rangeOfPath](functions/rangeOfPath.mdx)
* [recordOrigin](functions/recordOrigin.mdx)
* [resolveGeneratedLine](functions/resolveGeneratedLine.mdx)
* [runPasses](functions/runPasses.mdx)
* [seedOrigins](functions/seedOrigins.mdx)
* [setOrigin](functions/setOrigin.mdx)
* [shouldPinTarget](functions/shouldPinTarget.mdx)
* [sortPasses](functions/sortPasses.mdx)
* [transformSteps](functions/transformSteps.mdx)
* [transpile](functions/transpile.mdx)
* [validateWorkflowYaml](functions/validateWorkflowYaml.mdx)
* [visitJobs](functions/visitJobs.mdx)
* [visitSteps](functions/visitSteps.mdx)
* [workflow](functions/workflow.mdx)


## Sitemap

Browse the full documentation: [Markdown sitemap](https://austenstone.github.io/actio/sitemap.md) · [XML sitemap](https://austenstone.github.io/actio/sitemap.xml)