How yangmodels/yang works
Main components
• Repository (monorepo)
• Top-level directories:
– experimental/ (IETF, IEEE, ODP, other experimental modules)
– standard/ (IETF, IEEE, ETSI, BBF, MEF, IANA drafts/RFCs)
– vendor/ (Cisco, NetconfCentral, YumaWorks)
• Configuration and CI:
– .github/workflows/complete_check.yml
– .github/workflows/sdo_check.yml
– top-level scripts: testall.sh, check.sh (in each submodule)
• Submodules
• Standard bodies’ git submodules under standard/bbf, standard/mef, etc.
• Each brings its own directory hierarchy and check.sh
• Continuous Integration
• GitHub Actions
– Triggers on push/pull request
– Runs complete_check.yml which discovers check.sh in each major directory
– Invokes pyang to validate and produce schema trees
• External Services
• GitHub (repo hosting, PRs, issues)
• Slack (notifications, collaboration)
• pyang (YANG validator)
Relationships and interactions
• Contributor forks → clones → adds/updates modules → commits → opens a PR
• GitHub Actions picks up the PR
• complete_check.yml orchestrates:
• For each top-level area (experimental, standard, vendor): locate check.sh → run tests
• For submodules: navigate into subrepo, run its check.sh
• Results (pass/fail) reported back to GitHub PR
Architectural patterns and design principles
• Monorepo with logical grouping by domain/standard type
• Pluggable CI steps (each area supplies its own check.sh)
• Use of submodules to isolate third-party or standard‐body sources
• Convention-driven (directory names dictate license, CI entry points)
• Clear separation of concerns:
• Storage of YANG modules
• Validation pipelines
• Contribution workflow
Relevant technologies
• Git, Git submodules
• GitHub, GitHub Actions
• Shell scripts: check.sh, testall.sh
• pyang (YANG parser/validator)
• Markdown for documentation (README.md, READMEs in subdirs)
Detail and clarity
• Check.sh in each area as the CI entry point
• Testall.sh for local testing outside CI
• Where complete_check.yml references each check.sh
• Call out the convention: “each top-level area must supply its own check.sh for CI”