typeflows-github/io.typeflows.github.visualisation

Package-level declarations

Types

SingleWorkflowLayout

class SingleWorkflowLayout(workflow: Workflow) : Builder<MarkdownContent>

Generates a Mermaid flowchart visualization for a single workflow.

WorkflowTriggersFlowchart

class WorkflowTriggersFlowchart(workflows: DirectoryCollector<Workflow>) : Builder<MarkdownContent>

Generates a Mermaid flowchart visualization of workflow triggers and their relationships.

WorkflowVisualisations

class WorkflowVisualisations(workflows: DirectoryCollector<Workflow>) : TypeflowsDir

Generates visual documentation and diagrams for GitHub Actions workflows.

Functions

buildJobNodeLabel

fun buildJobNodeLabel(job: Job): String

createEventNodeId

fun createEventNodeId(trigger: Any): String

createEventNodeLabel

fun createEventNodeLabel(trigger: Any): String

fun String.escapeMermaid(): String

formatContainer

fun formatContainer(job: Job): String?

formatJobCondition

fun formatJobCondition(condition: String?): String?

fun formatTimeout(minutes: Int?): String?

getJobNodeShape

fun getJobNodeShape(job: Job): String

fun getJobOutputs(job: Job): String?

fun getMatrixInfo(job: Job): String?

fun getRunnerIcon(runsOn: RunsOn): String

fun getRunnerLabel(runsOn: RunsOn): String

getTriggerDetails

fun getTriggerDetails(trigger: Any): String?

getTriggerDisplayName

fun getTriggerDisplayName(trigger: Any): String

fun getTriggerIcon(trigger: Any): String

getWorkflowMetadata

fun getWorkflowMetadata(workflow: Workflow): String?

fun hasSecrets(job: Job): Boolean

fun sanitizeNodeId(name: String): String