Package io.typeflows.github.visualisation

Class WorkflowVisualisations

  • All Implemented Interfaces:
    io.typeflows.fs.TypeflowsFSEntry , io.typeflows.util.Named 
    
public final class WorkflowVisualisations
extends TypeflowsDir

    Generates visual documentation and diagrams for GitHub Actions workflows.

    This class creates comprehensive documentation including workflow overview diagrams, job flowcharts, and step-by-step breakdowns. It produces Markdown files with Mermaid diagrams that visualize workflow structure, dependencies, and execution flow for better understanding and documentation of automation pipelines.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      String getName()

      • Methods inherited from class io.typeflows.fs.TypeflowsDir

        writeTo

      • Methods inherited from class io.typeflows.util.Base

        equals, hashCode, toString

      • Methods inherited from class io.typeflows.fs.TypeflowsFSEntry

        plus

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • WorkflowVisualisations

        WorkflowVisualisations(DirectoryCollector<Workflow> workflows)