Criação de Especificação de Workflow do GitHub Actions

Crie uma especificação abrangente para o workflow do GitHub Actions: ${input:WorkflowFile}.

Esta especificação serve como um guia para o comportamento, requisitos e restrições do workflow. Ela deve ser independente da implementação, focando no que o workflow realiza, em vez de como ele é implementado.

Requisitos Otimizados por IA

• Eficiência de Tokens: Use linguagem concisa sem sacrificar a clareza.
• Dados Estruturados: Utilize tabelas, listas e diagramas para informações densas.
• Clareza Semântica: Use terminologia precisa de forma consistente em todo o documento.
• Abstração de Implementação: Evite sintaxe específica, comandos ou versões de ferramentas.
• Manutenibilidade: Projete para atualizações fáceis à medida que o workflow evolui.

Modelo de Especificação

Salvar como: /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[Evento de Gatilho] --> B[Job 1]
    B --> C[Job 2]
    C --> D[Job 3]
    D --> E[Fim]
    
    B --> F[Job Paralelo]
    F --> D
    
    style A fill:#e1f5fe
    style E fill:#e8f5e8

Jobs & Dependencies

Requirements Matrix

Functional Requirements

Security Requirements

Performance Requirements

Input/Output Contracts

Inputs

# Variáveis de Ambiente
ENV_VAR_1: string  # Propósito: [descrição]
ENV_VAR_2: secret  # Propósito: [descrição]

# Gatilhos do Repositório
paths: [lista de filtros de caminho]
branches: [lista de padrões de branch]

Outputs

# Saídas do Job
job_1_output: string  # Descrição: [propósito]
build_artifact: file  # Descrição: [tipo de conteúdo]

Segredos e Variáveis

Restrições de Execução

Restrições de Tempo de Execução

• Timeout: [Tempo máximo de execução]
• Concorrência: [Limites de execução paralela]
• Limites de Recursos: [Restrições de memória/CPU]

Restrições Ambientais

• Requisitos do Runner: [Necessidades de SO/hardware]
• Acesso à Rede: [Necessidades de conectividade externa]
• Permissões: [Níveis de acesso necessários]

Estratégia de Tratamento de Erros

Portões de Qualidade

Definições de Portões

Monitoramento e Observabilidade

Métricas Chave

• Taxa de Sucesso: [Porcentagem alvo]
• Tempo de Execução: [Duração alvo]
• Uso de Recursos: [Abordagem de monitoramento]

Alertas

Pontos de Integração

Sistemas Externos

Workflows Dependentes

…