Skip to content

Conversation

@github-actions
Copy link
Contributor

Layout Specification Update

This PR updates specs/layout.md with a comprehensive refresh of patterns extracted from compiled workflow files and source code.

What Changed

Major Improvements:

  • Restructured tables - Simplified GitHub Actions table format, removed usage counts, focused on practical reference
  • Enhanced artifact documentation - Organized into Standard, Memory/Cache, and Specialized categories with clear type indicators
  • Added Go constants section - Comprehensive documentation of all constants from pkg/constants/constants.go including versions, timeouts, and artifact names
  • Added JavaScript patterns - Documented common path construction and import patterns from actions/setup/js/
  • Expanded file paths - Detailed documentation of workflow, source code, and temporary runtime paths
  • Added environment variables - Complete list of core workflow and model configuration variables
  • Added GitHub context expressions - Common expressions and conditional patterns used in workflows
  • Added workflow patterns - Typical workflow structure, artifact flow, and environment variable setup patterns
  • Updated date - Last updated: 2025-12-30

New Sections:

  • Constants and Patterns (Go constants from pkg/constants/constants.go)
  • JavaScript Patterns (from actions/setup/js/)
  • Environment Variables (core workflow and model configuration)
  • GitHub Context Expressions (common patterns and conditionals)
  • Workflow Patterns (typical structures and flows)

Organizational Changes:

  • Removed usage count statistics (can change frequently)
  • Simplified SHA references to abbreviated form for readability
  • Added constant references where applicable (e.g., constants.AgentOutputArtifactName)
  • Reorganized artifacts into logical categories
  • Enhanced context descriptions for better understanding

Extraction Summary

  • Lock files analyzed: 128 workflow files
  • Actions cataloged: 18 unique GitHub Actions with pinned SHAs
  • Artifacts documented: 40+ artifact patterns (standard, memory, specialized)
  • Job patterns found: 24 common job names
  • File paths listed: 60+ paths across workflows, source, and temporary locations
  • Go constants: 50+ version, timeout, and configuration constants
  • JavaScript patterns: Common path construction and import patterns

Source Analysis

  • Scanned all .lock.yml files in .github/workflows/
  • Reviewed Go code in pkg/workflow/, pkg/cli/, pkg/constants/, pkg/parser/
  • Reviewed JavaScript code in actions/setup/js/
  • Extracted patterns using yq for YAML parsing
  • Extracted constants from Go source files
  • Documented JavaScript path construction patterns

Why These Changes

  1. Better reference document - Removed frequently-changing statistics in favor of stable patterns
  2. Source code integration - Added patterns directly from Go and JavaScript source
  3. More comprehensive - Covered constants, environment variables, and workflow patterns
  4. Developer-focused - Organized for quick lookup during development
  5. Maintainability - Structure better supports automated updates

File Changes

specs/layout.md | 493 insertions(+), 493 deletions(-)
Rewrite (93%)

Auto-generated by Layout Specification Maintainer workflow

AI generated by Layout Specification Maintainer

@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Dec 30, 2025
@pelikhan pelikhan merged commit 1f00c03 into main Dec 30, 2025
4 checks passed
@pelikhan pelikhan deleted the main-ac699ba0e62cdc54 branch December 30, 2025 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants