Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CIMTool builders to produce target artifacts (RDFS, OWL, etc.) that have output represented in a consistent and deterministic manner. #58

Closed
admin-cimug opened this issue Dec 30, 2022 · 0 comments
Assignees
Labels
bug Something isn't working

Comments

@admin-cimug
Copy link
Member

admin-cimug commented 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.

@admin-cimug admin-cimug added the enhancement New feature or request label Dec 30, 2022
@admin-cimug admin-cimug self-assigned this Dec 30, 2022
@admin-cimug 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
@admin-cimug admin-cimug added this to the release-1.11.1 milestone Dec 30, 2022
@admin-cimug admin-cimug added bug Something isn't working enhancement New feature or request and removed enhancement New feature or request bug Something isn't working labels Jan 3, 2023
@admin-cimug admin-cimug added bug Something isn't working and removed enhancement New feature or request labels Jan 3, 2023
tviegut added a commit that referenced this issue Jan 3, 2023
tviegut added a commit that referenced this issue Jan 3, 2023
This reverts commit b2a86ad.
tviegut added a commit that referenced this issue Jan 3, 2023
@tviegut tviegut closed this as completed Mar 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants