Create a formal specification for an existing GitHub Actions CI/CD workflow, optimized for AI consumption and workflow maintenance.

Create GitHub Actions Workflow Specification Create a comprehensive specification for the GitHub Actions workflow: ${input:WorkflowFile} . This specification serves as a specification for the workflow's behavior, requirements, and constraints. It must be implementation agnostic, focusing on what the workflow accomplishes rather than how it's implemented. AI Optimized Requirements Token Efficiency : Use concise language without sacrificing clarity Structured Data : Leverage tables, lists, and diagrams for dense information Semantic Clarity : Use precise terminology consistently throughout Implementation Abstraction : Avoid specific syntax, commands, or tool versions Maintainability : Design for easy updates as workflow evolves Specification Template Save as: /spec/spec process cicd [workflow name].md mermaid graph TD A[Trigger Event] B[Job 1] B C[Job 2] C D[Job 3] D E[End] B F[Parallel Job] F D style A fill: e1f5fe style E fill: e8f5e8 yaml Environment Variables ENV VAR 1: string Purpose: [description] ENV VAR 2: secret Purpose: [description] Repository Triggers paths: [list of path filters] branches: [list of branch patterns] yaml Job Outputs job 1 output: string Description: [purpose] build artifact: file Description: [content type] Analysis Instructions When analyzing the workflow file: 1. Extract Core Purpose : Identify the primary business objective 2. Map Job Flow : Create dependency graph showing execution order 3. Identify Contracts : Document inputs, outputs, and interfaces 4. Capture Constraints : Extract timeouts, permissions, and limits 5. Define Quality Gates : Identify validation and approval points 6. Document Error Paths : Map failure scenarios and recovery 7. Abstract Implementation : Focus on behavior, not syntax Mermaid Diagram Guidelines Flow Types Sequential : A B C Parallel : A B & A C; B D & C D Conditional : A B{Decision}; B Yes C; B No D Styling Complex Workflows For workflows with 5+ jobs, use subgraphs: Token Optimization Strategies 1. Use Tables : Dense information in structured format 2. Abbreviate Consistently : Define once, use throughout 3. Bullet Points : Avoid prose paragraphs 4. Code Blocks : Structured data over narrative 5. Cross Reference : Link instead of repeat information Focus on creating a specification that serves as both documentation and a template for workflow updates.

create-github-action-workflow-specification