How awslabs/aws-icons-for-plantuml works
File Structure Analysis
• Top-level directories:
• scripts/ contains Python scripts, PlantUML jars, Batik libs, config files and test harnesses to generate the distribution.
• Configuration & metadata:
• .github/ & .vscode/ for repo settings and CI templates.
• README.md, CONTRIBUTING.md, license files.
README Insights
• Emphasizes how users include AWSCommon.puml and other dist/ assets into PlantUML.
• Details build & distribution process (see scripts/README.md).
a. Main Components
• Version Control (GitHub) – hosts source, scripts, examples, dist, CI workflows.
• Source Assets – raw SVGs and intermediate PUML in source/official and source/unofficial.
• Distribution Artifact – generated .puml files under dist/, plus JSON theme files.
• CI/CD Pipeline – GitHub Actions triggers tests (scripts/test_upgrade.py), build, version bump, release.
b. Relationships & Interactions
1. Contributor pushes code → GitHub (Version Control).
2. CI/CD workflow picks up PR/commit → runs tests & build scripts.
3. Build Engine reads source/ and scripts/config.yml → transforms SVGs to .puml (via Batik + PlantUML jars) → writes dist/.
4. On success → CI/CD packages dist/ into a release artifact (GitHub Release, npm? etc.).
5. Examples reference the new dist/ → rendered by PlantUML and published in docs.
c. Architectural Patterns & Principles
• Separation of Concerns: raw assets vs. build logic vs. generated artifacts vs. examples.
• Code-as-Documentation: examples/ serve as runnable guides.
• Extensibility: new AWS services added by dropping SVGs in source/ and updating config.
d. Key Technologies & Frameworks
• Python 3.x scripts for orchestration (requirements.txt).
• PlantUML (multiple versions bundled as JARs) + Batik (SVG rasterizer).
• YAML configs (scripts/config.yml) drive file naming/version.
• GitHub Actions (workflow definitions in .github/workflows/).
• Markdown & PlantUML C4 model for examples.