Merge pull request #29 from dschwartznyc/main

CDM Deployment Prep

Author: dschwartz-ftadvisory

.github/workflows/build-and-tag-release-rosetta-bundle.yml

@@ -1,4 +1,5 @@
-name: Build JAR on Tag
+name: Create Tagged Release
+# Build JAR and create tagged release
 
 on:
   push:

.github/workflows/create-tagged-release.yml

@@ -1,57 +1,64 @@
-## Feature Request - CDM Python Generator Integration
+# Feature Request - CDM Python Generator Integration
+
+## Description of Problem
 
-### Description of Problem:
 With the Python generator now a standalone component, its integration with the CDM build needs to be updated. This presents two main challenges:
 
-1. **Consistency with CDM's Rosetta Bundle Version:** 
-To keep CDM in sync with all elements of the Rune DSL infrastructure (rosetta-common, rosetta-testing, rosetta-code-generators, rosetta-ingest), the CDM build specifies which version to use. Previously, the Python generator was kept in sync as part of the rosetta-code-generators repository, with updates whenever there was an update to the version in that repository. While the generated Python code does not directly depend on the Rune bundle, coordinating updates across all elements of the Rune infrastructure helps prevent inconsistencies in enterprise production enviroments — especially if a bundle update addresses a defect or changes behavior in a way that impacts the generators.
+1. **Consistency with CDM's Rosetta Bundle Version:**
+To keep CDM in sync with all elements of the Rune DSL infrastructure (rosetta-common, rosetta-testing, rosetta-code-generators, rosetta-ingest), the CDM build specifies which version to use. Previously, the Python generator was kept in sync as part of the rosetta-code-generators repository, with updates whenever there was an update to the version in that repository. While the generated Python code does not directly depend on it, coordinating updates across all elements of the Rune infrastructure helps prevent inconsistencies in enterprise production enviroments — especially if a dsl update addresses a defect or changes behavior in a way that impacts the generators.
 
 2. **Invocation of the standalone Python generator**:
 The CDM build now needs to explicitly invoke the unbundled Python generator.
 
 ---
-### Potential Solutions:
+
+## Potential Solutions
 
 Below are both a target state and interim steps to enable integration before the target state is fully realized.
 
-### Target state: 
+### Target state
+
+#### Assumptions
 
-#### Assumptions:
 - The generator includes an executable Main class that accepts a Rune source and a target folder for the generated Python.
 - The Rune Python Runtime is available via PyPI.
 
-#### Process:
-1. An update to the Rosetta Bundle Version triggers a rebuild of the generator.  If successful, a release tagged with the bundle version is generated.
-- Question: What is a viable source for the trigger?  Rosetta-Common?
-- Question: Is the generator uploaded to a central Maven repository or is it solely an artifact of the generator repository.
-2. The CDM build sources a generator version that matches its Rosetta Bundle Version.  The sequence is:
+#### Process
+
+1. An update to the Rosetta DSL Version triggers a rebuild of the generator.  If successful, a release tagged with the DSL version is generated.
+
+2. The CDM build sources a generator version that matches its Rosetta DSL Version.  The sequence is:
 
     1. Source the generator
     2. If found:
         1. Generate Python by invoking the new Main class using the source CDM Rune files.
         2. Package the resultung Python.
         3. Upload the package to PyPI.
-        
-        Question: Should the package also be made available as a Maven artifact?
     3. If not found: fail gracefully generating notice of the error.
 
-### Interim state: 
+### Interim state
+
+#### Assumptions
 
-#### Assumptions:
 - The generator is invoked using the current mechanism.
 - Python artifacts are distributed via the CDM Maven Repository.
 
 1. A scheduled action rebuilds the generator if the Rosetta Bundle Version used in CDM does not match any of tagged versions.  If successful, a release tagged with the bundle version is generated and stored as a repo artifact.  
 
 _Note: The downside of this approach is that there will be CDM builds that will not find a matching generator._
-
 2. The CDM build sources a generator that matches its Rosetta Bundle Version by querying the generator repo.  The sequence is:
     1. Source the generator
     2. If found:
-        1. Generate Python by executing: 
+        1. Generate Python by executing
+
         ```sh
         mvn clean install -DskipTests -P python
-        ``` 
+        ```
+
         2. Package the Python.
         3. Upload the package to the Maven repository.
-    3. If not found: fail gracefully generating notice of the error.
+    3. If not found: fail gracefully generating notice of the error
+
+## Questions
+
+- Should the package also be made available as a Maven artifact?

CDM-Build-Integration.md

@@ -4,13 +4,17 @@ _What is being released?_
 
 This release adds support for meta data and for serialization / deserialization consistent with the [serialization specifications in CDM issue #3236](https://github.com/finos/common-domain-model/issues/3236)
 
-Also included is support for circular dependencies and increased testing of operators.
+Also included is support for:
 
-# Reading From and Writing To a String
+- circular Type definitions
+- increased testing of operators
+- generating Python across multiple namespaces
+
+## Reading From and Writing To a String
 
 The generated Python code can deserialize and serialize an object.
 
-## Deserializing from a string
+### Deserializing from a string
 
 To deserialize from a string and create a object of the model specified in the string invoke the function:
 
@@ -27,9 +31,11 @@ To deserialize from a string and create a object of the model specified in the s
     Returns:
       BaseModel: The Rune model.
 
-To serialize from an object ("[obj]") of a generated class, invoke the function:
+### Serialize to a string
+
+To serialize from a Rune object ("obj"), invoke the function:
 
-`[obj].rune_serialize` with the following parameters:
+`obj.rune_serialize` with the following parameters:
 
     validate_model (bool, optional): Validate that the model passes all Rune defined constraings prior to serialization. Setting to False allows serialization of an invalid Model. Defaults to True.
 
@@ -59,7 +65,5 @@ To serialize from an object ("[obj]") of a generated class, invoke the function:
 
     exclude_none (bool, optional): Determines whether to exclude fields that have a value of `None`. If True, fields set to None will be included.  Defaults to False.
 
-
     Returns:
       A string.
-