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

WIP - Fix #252 - Add "About" menu with Maven version numbers #84

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

isabelle-dr
Copy link

PR by barbeau
Apr 18, 2018
Originally opened as CUTR-at-USF#327


Closes #52

Summary:

This is initial work towards building an API that exposes Maven version information for the project and showing this info when the user clicks on the "About" link in the webapp page header.

Details:

  • Uses buildnumber-maven-plugin to get the Git version umber and templating-maven-plugin to generate a class that has the Maven version and artifact info (VersionUtil) (see https://stackoverflow.com/a/36628755/937715)
    Problems:

  • templating-maven-plugin doesn't play well with IntelliJ. In other words, the project will fail to build in IntelliJ when you check it out because IntelliJ can't find the VersionUtil class. See this IntelliJ issue for implemementing support for templating-maven-plugin - https://youtrack.jetbrains.com/oauth?state=%2Fissue%2FIDEA-161010 . The current workaround is to build the project via Maven at the commandline first using mvn install, and then IntelliJ will recognize the class.

  • VersionApi.getVersion() doesn't seem to return the JSON version of the VersionModel when you return just the object (I get an empty response). Not sure why this isn't working. Other option is to return a String from this method and serialize to JSON using Jackson ObjectMapper directly.

TODO:

  • Looks like Find & Replace replaced all the version comment header Version with VersionModel (after the model class). This needs to be reverted.
  • Determine if templating-maven-plugin can be made compatible with IntelliJ. If not, we may need to switch to another method for getting Maven version information at runtime.
  • Webapp frontend

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

Successfully merging this pull request may close these issues.

Add "About" menu in webapp
2 participants