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

OZ-627: Add step to generate and copy Ozone info file #85

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

corneliouzbett
Copy link
Contributor

Issue: https://mekomsolutions.atlassian.net/jira/software/c/projects/OZ/issues/OZ-627

  • Added a new execution step in the maven-antrun-plugin to generate the ozone-info.txt file on the fly and another one in the maven-resources-plugin to copy the generated ozone-info.txt file to the final distro zip.

</goals>
<configuration>
<target>
<echo file="${project.build.directory}/ozone-info.txt">
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm guessing we could add more to it.
@mks-d , this is probably the foundation of this file where all versions of a given Ozone distros will be documented.
What would you suggest for its name and format?

Copy link
Contributor

Choose a reason for hiding this comment

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

You mean the format of the file itself? I guess that JSON is always better, as it will allow to nest version infos like addons explicitly added for every app, whenever applicable.

If it's indeed the file that starts stating the versions of the Ozone apps... then ozone-versions?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

JSON can be good format for representing structured & hierarchical data, but not ideal for informational text intended for human readability, however for this use case should be fine I guess since we can process the JSON further to a generate a rich & display friendly format e.g HTML or Markdown.

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's call this ozone-info.json for now. Let's see where that leads us.

@mks-d mks-d changed the title OZ-627: Add step to generate and copy ozone info file OZ-627: Add step to generate and copy Ozone info file Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants