🇺🇸English

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

---
title: CI/CD Workflow Specification - [Workflow Name]
version: 1.0
date_created: [YYYY-MM-DD]
last_updated: [YYYY-MM-DD]
owner: DevOps Team
tags: [process, cicd, github-actions, automation, [domain-specific-tags]]
---

## Workflow Overview

**Purpose**: [One sentence describing workflow's primary goal]
**Trigger Events**: [List trigger conditions]
**Target Environments**: [Environment scope]

## Execution Flow Diagram

```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

Jobs & Dependencies

Requirements Matrix

Functional Requirements

Security Requirements

Performance Requirements

Input/Output Contracts

Inputs

# 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]

Outputs

# Job Outputs
job_1_output: string  # Description: [purpose]
build_artifact: file  # Description: [content type]

Secrets & Variables

Execution Constraints

Runtime Constraints

• Timeout : [Maximum execution time]
• Concurrency : [Parallel execution limits]
• Resource Limits : [Memory/CPU constraints]

Environmental Constraints

• Runner Requirements : [OS/hardware needs]
• Network Access : [External connectivity needs]
• Permissions : [Required access levels]

Error Handling Strategy

Quality Gates

Gate Definitions

Monitoring & Observability

Key Metrics

• Success Rate : [Target percentage]
• Execution Time : [Target duration]
• Resource Usage : [Monitoring approach]

Alerting

Integration Points

External Systems

Dependent Workflows

Compliance & Governance

Audit Requirements

• Execution Logs : [Retention policy]
• Approval Gates : [Required approvals]
• Change Control : [Update process]

Security Controls

• Access Control : [Permission model]
• Secret Management : [Rotation policy]
• Vulnerability Scanning : [Scan frequency]

Edge Cases & Exceptions

Scenario Matrix

Validation Criteria

Workflow Validation

• VLD-001 : [Validation rule]
• VLD-002 : [Validation rule]

Performance Benchmarks

• PERF-001 : [Benchmark criteria]
• PERF-002 : [Benchmark criteria]

Change Management

Update Process

1. Specification Update : Modify this document first
2. Review & Approval: [Approval process]
3. Implementation : Apply changes to workflow
4. Testing : [Validation approach]
5. Deployment : [Release process]

Version History

Related Specifications

• [Link to related workflow specs]

• [Link to infrastructure specs]

• [Link to deployment specs]

  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

Complex Workflows

For workflows with 5+ jobs, use subgraphs:

graph TD
    subgraph "Build Phase"
        A[Lint] --> B[Test] --> C[Build]
    end
    subgraph "Deploy Phase"  
        D[Staging] --> E[Production]
    end
    C --> D

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.

Weekly Installs

7.5K

Repository

github/awesome-copilot

GitHub Stars

26.7K

First Seen

Feb 25, 2026

Security Audits

Gen Agent Trust HubPassSocketPassSnykPass

Installed on

codex7.4K

gemini-cli7.4K

opencode7.4K

cursor7.4K

github-copilot7.4K

kimi-cli7.4K