You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In the context of published IEC International Standards CIMTool is used to create the profile artifacts (i.e. RDFS schemas, XSD schemas, JSON schemas, etc.) that correspond to the profiles defined in those standards. It is highly desirable to host such CIMTool projects in publicly available GitHub repositories where they can be managed using well established source code control mechanisms and versioning and release best practices. A key benefit is that deltas to a profile can be tracked and file-based comparisons performed using GitHub's built in features.
This issue aims to address a deficiency within CIMTool that currently diminishes the value of such file-based comparisons. Currently, generated artifacts (e.g. *.owl, *.legacy-rdfs-augments, *.legacy-rdfs, etc.) have non-deterministic ordering of the generated XML output. This can result in two different orderings depending on the order a user adds classes/attributes to the profile. As a result, the current codebase should be updated to properly sort and alphabetically order the generated output. Simple ordering is viewed as potentially the simplest approach to achieve consistent output that can be easily compared between versions committed to a GitHub repository.
The text was updated successfully, but these errors were encountered:
admin-cimug
changed the title
Update CIMTool builders to produce target output (RDFS, OWL, etc. artifacts ) that is consistent and deterministic.
Update CIMTool builders to produce target artifacts (RDFS, OWL, etc.) that have output represented in a consistent and deterministic manner.
Dec 30, 2022
In the context of published IEC International Standards CIMTool is used to create the profile artifacts (i.e. RDFS schemas, XSD schemas, JSON schemas, etc.) that correspond to the profiles defined in those standards. It is highly desirable to host such CIMTool projects in publicly available GitHub repositories where they can be managed using well established source code control mechanisms and versioning and release best practices. A key benefit is that deltas to a profile can be tracked and file-based comparisons performed using GitHub's built in features.
This issue aims to address a deficiency within CIMTool that currently diminishes the value of such file-based comparisons. Currently, generated artifacts (e.g.
*.owl
,*.legacy-rdfs-augments
,*.legacy-rdfs
, etc.) have non-deterministic ordering of the generated XML output. This can result in two different orderings depending on the order a user adds classes/attributes to the profile. As a result, the current codebase should be updated to properly sort and alphabetically order the generated output. Simple ordering is viewed as potentially the simplest approach to achieve consistent output that can be easily compared between versions committed to a GitHub repository.The text was updated successfully, but these errors were encountered: