Skip to content

Conversation

@github-actions
Copy link
Contributor

Layout Specification Update

This PR updates specs/layout.md with the latest patterns extracted from compiled workflow files.

What Changed

This comprehensive update includes:

  • Analyzed 128 lock files (previously 117) - captured 11 new workflows
  • Added usage count metrics - shows frequency of each GitHub Action (e.g., actions/github-script used 2,436 times)
  • Reorganized artifact documentation - clearer categorization with producer/consumer relationships
  • Added firewall logs pattern - documented 128 unique firewall-logs artifacts (one per workflow)
  • Expanded constants section - extracted all constants from pkg/constants/constants.go including:
    • Path constants (ScriptsBasePath, SetupActionDestination, etc.)
    • Job/step IDs and output names
    • Version constants for all tools and runtimes
    • Feature flags and timeout values
    • Default tool lists with counts
  • Added field ordering patterns - documented priority order for steps, jobs, and workflow fields
  • Enhanced usage guidelines - practical guidance for naming, paths, and configuration
  • Improved organization - better categorization and clearer context

Extraction Summary

  • Lock files analyzed: 128 (+11 from previous)
  • GitHub Actions cataloged: 19 unique actions with usage counts
  • Artifacts documented: 140+ (including per-workflow firewall logs)
  • Job patterns found: 20+ common patterns
  • File paths listed: 50+ organized by category
  • Constants extracted: 70+ from source code

Key Improvements

  1. Usage Metrics: Added usage counts showing action frequency (e.g., actions/github-script: 2,436 uses)
  2. Better Context: Each pattern now includes producer/consumer relationships
  3. Source Code Integration: Extracted patterns directly from Go constants and code
  4. Comprehensive Coverage: Captured all 128 workflows vs previous 117
  5. Practical Guidelines: Added concrete usage recommendations

Source Analysis

  • ✅ Scanned all .lock.yml files in .github/workflows/ (128 files)
  • ✅ Reviewed Go code in pkg/workflow/ and pkg/constants/
  • ✅ Extracted patterns from pkg/constants/constants.go (455 lines)
  • ✅ Analyzed artifact upload/download patterns with yq
  • ✅ Counted action usage frequency across all workflows

File Changes

  • Lines changed: +493 additions, -723 deletions (net -230 lines)
  • More focused: Removed redundant sections, added structured data
  • Better organized: Clearer categorization and improved tables

Auto-generated by Layout Specification Maintainer workflow

AI generated by Layout Specification Maintainer

- Analyzed 128 lock files (+11 from previous 117)
- Added usage count metrics for all GitHub Actions
- Reorganized artifacts with producer/consumer relationships
- Documented 128 firewall-logs artifacts (one per workflow)
- Extracted 70+ constants from pkg/constants/constants.go
- Added field ordering patterns for YAML
- Enhanced usage guidelines and best practices
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Dec 29, 2025
@pelikhan pelikhan merged commit 157d78e into main Dec 29, 2025
4 checks passed
@pelikhan pelikhan deleted the main-24b1b7eae91e2c6a branch December 29, 2025 09:43
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.

1 participant