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.

Sign up for GitHub

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

Jump to bottom

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
Draft

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions maven-parent/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,28 @@
</resources>
</configuration>
</execution>

<execution>
<!-- Copy Ozone Info to Final Distro -->
<id>Copy Ozone Info to Final Distro</id>
<phase>prepare-package</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${project.build.directory}/${project.artifactId}-${project.version}/distro</outputDirectory>
<resources>
<resource>
<directory>${project.build.directory}</directory>
<includes>
<include>ozone-info.txt</include>
</includes>
<filtering>false</filtering>
</resource>
</resources>
<overwrite>true</overwrite>
</configuration>
</execution>
</executions>
</plugin>

Expand Down Expand Up @@ -323,6 +345,22 @@
</target>
</configuration>
</execution>

<execution>
<!-- Generate Ozone Distro Info -->
<id>Generate Ozone Distro Info</id>
<phase>generate-resources</phase>
<goals>
<goal>run</goal>
</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.

ozone.name=${project.artifactId}
</echo>
</target>
</configuration>
</execution>
</executions>
<dependencies>
<dependency>
Expand Down
Loading