How swiftlang/github-workflows works
Main Components
a) Workflow Categories Layer
• Soundness Workflows
• Testing Workflows
• Future Workflows (like macOS support, marked as planned)
b) Integration Layer
• GitHub Actions Runner Infrastructure
• Local Testing Infrastructure (Act)
c) Execution Environment Layer
• Linux Environment
• Windows Environment
• Future macOS Environment
Key Relationships
• How consumer repositories integrate with these workflows
• How workflows interact with different execution environments
• How various checks and tests are orchestrated
Specific Implementation Details
┌─ Consumer Repositories Layer ─────────────────────┐
• Swift Package Repos Swift Compiler Repos │
• ┼──────────────────────┼────────────────┘
┌─ Workflow Integration Layer ───┼────────────────┐
• ┌──────▼──────────┐ ┌──────▼──────────┐ │
• Soundness │ │ Testing │ │
• Workflow │ │ Workflow │ │
• ┬──────────┘ └──────┬──────────┘ │
• ┼──────────────────────┼────────────────┘
┌─ Checks & Tests Layer ────────┼────────────────┐
• ┌────▼───────────────┐ │ │
• License Headers │ │ │
• Formatting │ │ │
• Symlinks │ ┌───▼──────────┐ │
• Documentation │ │ Swift Tests │ │
• YAML Lint │ │ (Multiple │ │
• ┘ │ Versions) │ │
• ┘ │
• ┘
┌─ Execution Environments ──────────────────────────┐
• Linux Windows macOS (Future) │
• ┘
Important Details to Capture
• Version Support Matrix:
• Swift versions (5.8, 5.9, 5.10, 6.0, nightly)
• Platform-specific exclusions
• Integration Points:
• Local testing with Act
• GitHub Actions integration
• Pre-build command support
Additional Recommendations
• Annotations for configuration options
• Error/feedback paths
• Version compatibility matrix as a supplementary element