How alisw/alidist works
Project Type and Purpose
• Project Type: A build orchestration and recipe management system.
• Purpose: To provide standardized recipes/scripts tailored to fetching, patching, building, and integrating external software packages (with a focus on ALICE SW). The repository also includes guidelines for commit messages, contributing recipes, and handling external sources.
File Structure
• Top-level Directories/Files: The repository contains a .github directory with multiple workflow files (CI/CD pipelines) and a large number of shell scripts (e.g., aliroot.sh, o2.sh, aliphysics.sh, etc.) which are the individual recipes.
• Architectural Implications: The separation between automation (GitHub workflows) and build recipes (shell scripts) indicates a division between orchestration (CI/CD) and the actual build logic. There is no traditional backend/frontend separation but rather a modular, script-based build environment.
• Additional Files: Configuration files, commit and contributing guidelines embedded in the README provide context for how the recipes are maintained and how external sources should be integrated.
Insights from the README
• The README stresses guidelines for commit messages, contributing recipes, and for managing external sources which implies an emphasis on reproducibility, clarity, and consistency in the build process.
• It also details how to handle system dependencies versus using internal builds, which is a key element to represent in the system architecture.
a. Main Components:
• Recipe Engine: Represented by the multitude of shell script files (e.g., aliroot.sh, o2.sh, etc.). Each recipe can be considered as a module or micro-component responsible for building a specific package.
• CI/CD Orchestration: The .github/workflows directory represents the automated pipelines that validate, test, and eventually trigger these build recipes.
• Configuration & Guidelines: The README and associated policy documents form the “governance” component that ensures proper usage and consistency across the system.
• External Sources & Dependencies: Although not a separate directory, the guidelines for handling externals (GitHub mirrors, tarball imports, etc.) indicate an external integration layer responsible for managing the origin of source code and patches.
b. Relationships and Interactions:
• The CI/CD workflows (one node/module) trigger the execution of individual build recipes (another module) through shell commands.
• Recipes may depend on external sources (depicted as an “External Source Repository” node) and system-installed libraries when applicable.
• The governance component (represented by the README/documentation node) influences how recipes are written, maintained, and versioned.
c. Architectural Patterns and Principles:
• Modular Design: Each build recipe is independent, facilitating easy additions or updates.
• Declarative Build Process: The repository emphasizes guidelines and reproducible builds (such as using defined environment variables like SOMETHING_ROOT).
• CI/CD Integration: Automated workflows manage testing and release processes, ensuring consistency across builds.
d. Relevant Technologies and Frameworks:
• CI/CD: GitHub Actions (with multiple workflow configuration files).
• Shell Scripting: The core logic is in various .sh scripts that execute build and configuration commands.
• External Tools: References to typical build tools (CMake, autotools, etc.) are implied in the recipes as they prepare environments for different external software.
• While it is not necessary to capture every single script, it is important to represent the modular, recipe-based approach. You might group similar build recipes or indicate a “recipe library” node.
• Be as detailed as possible in mapping out the high-level components and then include sub-nodes for important workflows or groups of recipes if needed.