Skip to content

Serialization and HTML subdirectories when bundling#1356

Open
coltonglasgow wants to merge 7 commits intodevelopfrom
1347-subdirectories-during-bundling
Open

Serialization and HTML subdirectories when bundling#1356
coltonglasgow wants to merge 7 commits intodevelopfrom
1347-subdirectories-during-bundling

Conversation

@coltonglasgow
Copy link
Contributor

@coltonglasgow coltonglasgow commented Nov 12, 2025

Closes #1347

I have implemented the following when bundling:

  • Create turtle, rdf-xml, and json-ld directories in the ontologies directory.
  • Create markdown and html directories for docs/ and migration/v*/.
  • Create docs/markdown/models/ and docs/html/models/.

This gist bundle contains the changes listed above: gist14.1.0_webDownload.zip

This screenshot is from the gist bundle (above) showing the changes:
Image

@coltonglasgow coltonglasgow changed the title Creating serialization and HTML subdirectories when bundling Serialization and HTML subdirectories when bundling Nov 12, 2025
Copy link
Contributor

@stevenchalem stevenchalem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This runs fine under Windows 11. Also see my comment at #1347 (comment)

@coltonglasgow coltonglasgow marked this pull request as ready for review November 14, 2025 01:11
@coltonglasgow
Copy link
Contributor Author

coltonglasgow commented Nov 14, 2025

I have updated this PR based on the feedback from the issue: #1347.
This PR is ready for review.

Comment on lines -122 to -123
excludes:
- gistValidationAnnotations.ttl
Copy link
Contributor Author

@coltonglasgow coltonglasgow Nov 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a duplicate line that did not do anything. This file is being excluded above on line 107.

Copy link
Contributor

@stevenchalem stevenchalem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Runs correctly under Windows 11 and produces the correct results.

@stevenchalem stevenchalem moved this from In Progress to In Review in gist Version 14.1.0 Nov 14, 2025
@rjyounes
Copy link
Collaborator

Directory names html and markdown are unclear in the migration directories. How about something like html-doc and markdown-doc for these directories?

@coltonglasgow
Copy link
Contributor Author

coltonglasgow commented Dec 17, 2025

Directory names html and markdown are unclear in the migration directories. How about something like html-doc and markdown-doc for these directories?

@rjyounes I have applied this suggestion in the latest commit.

Copy link
Collaborator

@rjyounes rjyounes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, everything works. I have just a suggestion for the release note.

Co-authored-by: Rebecca Younes <rebecca.younes@semanticarts.com>
@coltonglasgow coltonglasgow requested a review from rjyounes March 9, 2026 19:44
Copy link
Collaborator

@rjyounes rjyounes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, one more round on the release note.

@@ -0,0 +1,3 @@
### Patch Updates

- Added format-specific directory creation for ontology and documentation files to `bundle.yaml`. Issue [#1347](https://github.com/semanticarts/gist/issues/1347).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I suggested a change to this once already, but now it strikes me it would be better to word the note in terms of what the user will see in the release package rather than what the code change was. E.g., something like "Modified build to store ontology and documentation files in format-specific directories in the release package."

Copy link
Collaborator

@sa-bpelakh sa-bpelakh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I didn't even remember that onto-tool automatically created output directories. 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Review

Development

Successfully merging this pull request may close these issues.

Organize ontology and documentation files in release package into subdirectories by file type

4 participants