Document and standardize bootstrap approach for pre-generated binding classes

[david-waltermire]

Summary

Some modules contain pre-generated binding classes that cannot be generated during normal builds due to circular dependencies or complex configurations. A standardized bootstrap approach is needed.

Background

The metaschema-maven-plugin creates circular dependencies when used in certain modules:

• metaschema-testing: metaschema-maven-plugin → metaschema-schema-generator → metaschema-testing
• databind: Complex binding configurations require manual post-processing

Current Bootstrap Pattern

Implemented in metaschema-testing (PR #567):

• pom-bootstrap.xml - Standalone POM for regeneration
• Pre-generated classes checked into src/main/java
• README.md documents regeneration process
• CLAUDE.md includes bootstrap instructions

Proposed Standardization

1. Naming Convention: pom-bootstrap.xml for regeneration POMs
2. Documentation: Each module with bootstrap classes should have:
   • README section explaining the bootstrap process
   • Reference in main CLAUDE.md
3. Directory Structure:

   module/
   ├── pom.xml              # Normal build (no plugin)
   ├── pom-bootstrap.xml    # Regeneration only
   ├── README.md            # Documents bootstrap process
   └── src/main/
       ├── metaschema/          # Source Metaschema modules
       ├── metaschema-bindings/ # Binding configurations
       └── java/.../binding/    # Pre-generated classes
   

Modules Requiring Bootstrap

• metaschema-testing - Implemented in PR feat: remove XMLBeans dependency from metaschema-testing module #567
• databind - See Extend code generator to support complex interface patterns in databind bindings #572 for code generator enhancements needed first

Acceptance Criteria

• Document bootstrap pattern in project-level documentation
• Create pom-bootstrap.xml for all modules with pre-generated bindings
• Add README.md to each module explaining regeneration
• Update CLAUDE.md with complete bootstrap documentation

Related

• Extend code generator to support complex interface patterns in databind bindings #572 - Extend code generator for databind bootstrap
• PR feat: remove XMLBeans dependency from metaschema-testing module #567 - XMLBeans removal (implements pattern for metaschema-testing)

[coderabbitai]

📝 CodeRabbit Plan Mode

Generate an implementation plan and prompts that you can use with your favorite coding agent.

• Create Plan

Examples

• Example 1
• Example 2

---

🔗 Similar Issues

Related Issues

• Extend code generator to support complex interface patterns in databind bindings #572
• Enhance code generator to produce complete Javadoc for binding classes #571
• Nightly snapshot builds of develop and feature branches #349
• Nightly snapshot builds of develop and feature branches oscal-cli#104
• Nightly snapshot builds of develop and feature branches liboscal-java#110

🔗 Related PRs

#566 - feat: remove XMLBeans dependency from databind module [merged]

👤 Suggested Assignees

• david-waltermire
• aj-stein-gsa

---

🧪 Issue enrichment is currently in open beta.

You can configure auto-planning by selecting labels in the issue_enrichment configuration.

To disable automatic issue enrichment, add the following to your .coderabbit.yaml:

issue_enrichment:
  auto_enrich:
    enabled: false

💬 Have feedback or questions? Drop into our discord!