API Reference

Complete documentation of the WorkflowKt public API.

Packages

Package	Description
ir.amirroid.workflowkt	Core interfaces (GithubAction, ActionResult)
ir.amirroid.workflowkt.context	Typed event contexts for each GitHub event
ir.amirroid.workflowkt.environment	Environment variable access layer
ir.amirroid.workflowkt.models	Data models for GitHub API payloads
ir.amirroid.workflowkt.core	Context factory (internal use)
ir.amirroid.workflowkt.core.mapper	JSON-to-context mappers (internal use)
ir.amirroid.workflowkt.utils	Constants for event names and environment keys

Quick Reference

Core Types

Type	Description
GithubAction<C>	Interface implemented by all workflows
ActionResult	Sealed interface for success/failure outcomes
ActionContext	Sealed interface for all event contexts
GithubEnvironment	Interface for reading environment variables

Context Types

Context	GitHub Event	Source File
IssueContext	issues	context/IssueContext.kt
PullRequestContext	pull_request	context/PullRequestContext.kt
PushContext	push	context/PushContext.kt
ReleaseContext	release	context/ReleaseContext.kt
ScheduleContext	schedule	context/ScheduleContext.kt
WorkflowDispatchContext	workflow_dispatch	context/WorkflowDispatchContext.kt
CreateContext	create	context/CreateContext.kt

Model Types

See Models for the complete list of data models.