How actions/starter-workflows works
Main Components
• GitHub Actions Starter Workflows: This is the overall catalog of YAML workflow templates.
• Directories based on workflow purpose:
• CI (Continuous Integration): Contains YAML files and properties (for example, “ci/django.yml”) that facilitate CI tasks.
• Deployments: Contains deployment-specific workflow YAML files for various platforms (AWS, Azure, Google Cloud, etc.) along with properties files.
• Automation: Contains workflow templates for automating common tasks (e.g., greetings, labeling, stale workflows).
• Code Scanning: Comprises various security and code quality scanning workflows.
• Pages: Contains templates related to static site generators and hosting platforms.
• Supporting Assets:
• Additional scripts: Under the “script” directory, with submodules like sync-ghes and validate-data. These scripts likely support external processes or data validation.
• Configuration and Automation Files: The repository’s .github directory, pre-commit, CODEOWNERS, CONTRIBUTING.md, and other meta files help with repository automation and governance.
Relationships and Interactions
• That every YAML workflow file is paired with a corresponding .properties.json file in a “properties” subdirectory (for example, “ci/django.yml” with “ci/properties/django.properties.json”).
• External dependencies:
• The GitHub Actions platform which consumes these workflow files and displays metadata from the properties files.
• The integration with hosting providers and external services given the deployment templates.
Architectural Patterns and Design Principles
• Modularity: The separation of workflow templates into multiple directories (CI, deployments, etc.) emphasizes modularity and single responsibility.
• Separation of Concerns: Each directory addresses a specific function (e.g., testing vs. deployment vs. code scanning).
• Metadata Driven Design: The use of .properties.json files to supply additional information shows a clear separation between workflow logic and descriptive metadata, enabling flexibility in rendering and categorization on the GitHub UI.
Relevant Technologies and Tools
• GitHub Actions: This is the underlying platform that utilizes these YAML workflows.
• YAML and JSON: For workflow definitions and metadata respectively.
• Git and GitHub: Version control and hosting, including the use of GitHub workflows (.github/workflows).
• Integration scripts (in TypeScript): Under the “script” directory, supporting additional operational tasks.
Elements
• A clear visual block for each top-level directory: ci, deployments, automation, code-scanning, and pages.
• Labels on each component explaining its role and any dependencies (e.g., “CI Workflows – for running tests and builds”).