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

Code Infrastructure: create a Maven Parent POM and integrate existing #8394

Closed
poikilotherm opened this issue Feb 3, 2022 · 1 comment · Fixed by #8395
Closed

Code Infrastructure: create a Maven Parent POM and integrate existing #8394

poikilotherm opened this issue Feb 3, 2022 · 1 comment · Fixed by #8395
Labels
Component: Code Infrastructure formerly "Feature: Code Infrastructure" Component: Containers Anything related to cloudy Dataverse, shipped in containers. Feature: Developer Guide
Milestone
5.10

Comments

@poikilotherm
Copy link
Contributor

poikilotherm commented Feb 3, 2022 •
edited
Loading

This is influenced by #7662 / #8320 , #8383, #6505 / #6986, #8250, #2331 and related.

Tagging @qqmyers @landreev @scolapasta @pdurbin here.
EDIT: @pdurbin suggested this is related to #2331 and @donsizemore suggested this might be related to activities by @akio-sone

Current status

  • Currently, there is a standalone pom.xml to compile, test and package the Dataverse WAR.
  • The ZIP downloader JAR also has a standalone pom.xml in subdir scripts/zipdownload

Envisioned future

  • Create a parent POM in a subdirectory of project root (e.g. conf/pom.xml or a new folder structure modules/dataverse-parent/pom.xml or similar).
  • Inherit in edu.harvard.iq.dataverse POM from parent
  • Move relevant sections and parts from <properties>, <pluginRepositories>, <repositories>, <dependencyManagement> and maybe some of <build> into the parent POM
  • Make ZIP downloader POM inherit from parent

Possibilities

  • Enable consistent dependency management for main project and ZIP downloader
  • Enable central configuration of Maven metadata, repositories etc (also needed to upload to Maven Central one day)
  • Enable dependencies between our modules
  • Enable starting to transform the main codebase from a monolith to a modulith, enabling reuse of code parts like storage access (looking at you, ZIP downloader)
  • Decouple main development POM maintenance from other activities like Maven based containers (but still be able to depend on them!)
  • Future replacement of scripts/installer/Makefile with a Maven submodule dataverse-release doing the packaging? Maybe also doing the actual release process (JReleaser FTW!)?
  • Future release dataverse-parent on its own, enabling other projects to inherit.

Hints

  • @pdurbin suggested to give an example of a not-to-complex project using Maven modules. Here is a very similar one to Dataverse 😋 : https://github.com/DSpace/DSpace (Although they aren't having a parent in a subdirectory - this is sth we need to be backward compatible for at least some time)
  • The current pom.xml will not be moved, just transformed. No Git history "lost"/"invisible". Any developer currently acclimated with using mvn <target> to interact with the main codebase on project basedir will not need to change habits. Obviously shared properties etc would be managed within the parent.
  • The parent POM is not only usable for inheritance, but also for aggregation. Accessing the subdirectory and running a Maven target will include all submodules in one go, respecting dependencies.
  • For easier insights into my suggestion, I created a working pull request: 8394 maven mods #8395 Feel free to add any suggestions etc.
@poikilotherm poikilotherm added Component: Code Infrastructure formerly "Feature: Code Infrastructure" Component: Containers Anything related to cloudy Dataverse, shipped in containers. Feature: Developer Guide labels Feb 3, 2022
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 3, 2022
@poikilotherm
build(parent): add a basic Maven Parent POM IQSS#8394
7490fae
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 3, 2022
@poikilotherm
build(dataverse): make main pom.xml inherit from new dataverse-parent I…
18f7532 
…QSS#8394

This includes moving/inheriting some project properties from the parent.
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 3, 2022
@poikilotherm
build(dataverse): make Maven plugin versions controlled by parent IQS…
e8ce58d 
…S#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 3, 2022
@poikilotherm
chore(jacoco): fix wrongly typed config options of JaCoCo Maven plugin …
72d57c1 
…IQSS#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 3, 2022
@poikilotherm
build(dataverse): move <pluginRepositories> and <repositories> to par…
a859c30 
…ent IQSS#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 3, 2022
@poikilotherm
build(dataverse): move common version properties to parent IQSS#8394
509d4d7
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 3, 2022
@poikilotherm
build(dataverse): make SolrJ dependency use a version from parent IQS…
efc5064 
…S#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 3, 2022
@poikilotherm
build(dataverse): move common entries from <dependencyManagement> to …
b4d1679 
…parent IQSS#8394
@poikilotherm poikilotherm mentioned this issue Feb 3, 2022
Merged
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 3, 2022
@poikilotherm
ci(unit): make Github Action for Maven Unit Tests be triggered on POM…
96fde95 
… changes IQSS#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 7, 2022
@poikilotherm
build(parent): add a basic Maven Parent POM IQSS#8394
41b7f69
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 7, 2022
@poikilotherm
build(dataverse): make main pom.xml inherit from new dataverse-parent I…
4a00775 
…QSS#8394

This includes moving/inheriting some project properties from the parent.
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 7, 2022
@poikilotherm
build(dataverse): make Maven plugin versions controlled by parent IQS…
1db3e08 
…S#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 7, 2022
@poikilotherm
chore(jacoco): fix wrongly typed config options of JaCoCo Maven plugin …
96bf1bd 
…IQSS#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 7, 2022
@poikilotherm
build(dataverse): move <pluginRepositories> and <repositories> to par…
0634291 
…ent IQSS#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 7, 2022
@poikilotherm
build(dataverse): move common version properties to parent IQSS#8394
a07da3e
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 7, 2022
@poikilotherm
build(dataverse): make SolrJ dependency use a version from parent IQS…
11cd31c 
…S#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 7, 2022
@poikilotherm
build(dataverse): move common entries from <dependencyManagement> to …
236f0dd 
…parent IQSS#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 7, 2022
@poikilotherm
ci(unit): make Github Action for Maven Unit Tests be triggered on POM…
90a1d96 
… changes IQSS#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 7, 2022
@poikilotherm
build(dataverse): move postgresql lib versioning to parent <dependenc…
b7e2d79 
…yManagement> IQSS#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 7, 2022
@poikilotherm
build(zipdownloader): make zipdownloader use parent POM IQSS#8394
13de98b
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 7, 2022
@poikilotherm
refactor(zipdownloader): replace Maven Assembly Plugin with Spring Boot
ffa8e0d 
IQSS#8394

The Spring Boot method to create an executable fat/uber JAR is offering a much better
experience than what Maven Assembly does. It provides a custom bootloader to load
JARs from the JAR, which means less potential for conflicts etc.

It also offers options to be integrated in other workflows like container images etc.
The package is now about 8.2 MB in size, which is negligible compared to 8.0 MB via
the Assembly plugin.
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 9, 2022
@poikilotherm
build(parent): add a basic Maven Parent POM IQSS#8394
2e76494
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 9, 2022
@poikilotherm
build(dataverse): make main pom.xml inherit from new dataverse-parent I…
f102122 
…QSS#8394

This includes moving/inheriting some project properties from the parent.
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 9, 2022
@poikilotherm
build(dataverse): make Maven plugin versions controlled by parent IQS…
c70e75c 
…S#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 9, 2022
@poikilotherm
chore(jacoco): fix wrongly typed config options of JaCoCo Maven plugin …
424400b 
…IQSS#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 9, 2022
@poikilotherm
build(dataverse): move <pluginRepositories> and <repositories> to par…
8fb4b9a 
…ent IQSS#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 9, 2022
@poikilotherm
build(dataverse): move common version properties to parent IQSS#8394
6089cbb
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 9, 2022
@poikilotherm
build(dataverse): make SolrJ dependency use a version from parent IQS…
0ad680c 
…S#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 9, 2022
@poikilotherm
build(dataverse): move common entries from <dependencyManagement> to …
c56e901 
…parent IQSS#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 9, 2022
@poikilotherm
ci(unit): make Github Action for Maven Unit Tests be triggered on POM…
477a180 
… changes IQSS#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 9, 2022
@poikilotherm
build(dataverse): move postgresql lib versioning to parent <dependenc…
19b9bec 
…yManagement> IQSS#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 9, 2022
@poikilotherm
build(zipdownloader): make zipdownloader use parent POM IQSS#8394
ea59f8a
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 9, 2022
@poikilotherm
refactor(zipdownloader): replace Maven Assembly Plugin with Spring Boot
41e80db 
IQSS#8394

The Spring Boot method to create an executable fat/uber JAR is offering a much better
experience than what Maven Assembly does. It provides a custom bootloader to load
JARs from the JAR, which means less potential for conflicts etc.

It also offers options to be integrated in other workflows like container images etc.
The package is now about 8.2 MB in size, which is negligible compared to 8.0 MB via
the Assembly plugin.
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 9, 2022
@poikilotherm
build(deps): re-add SLF4J changes from IQSS#8377 in parent IQSS#8394
febc61d
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 9, 2022
@poikilotherm
build(modules): move Maven plugin versioning to parent IQSS#8394
fbdf5c1
landreev added a commit to poikilotherm/dataverse that referenced this issue Feb 9, 2022
@landreev
changing the zipper shell script
eca267e 
(to reflect the changed name of the jar file) IQSS#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 10, 2022
@poikilotherm
docs(dev): rework dependencies.rst and add parent POM IQSS#8394
452feea 
This commit adds a lot of new terms used to understand how parent POMs
work. It also introduces many graphs to visualize the described.

The parent POM used within the Dataverse codebase is explained: what it
does, how it's connected to other parts etc.
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 10, 2022
@poikilotherm
build(zipdownloader): change version number to experimental IQSS#8394
b416618 
This is in accordance with @landreev
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 10, 2022
@poikilotherm
refactor(zipdownloader): adapt cgi-bin script to name and version of …
c91c071 
…JAR IQSS#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 10, 2022
@poikilotherm
docs(zipdownloader): refactor slightly for name and version, crosslink …
429ec3f 
…IQSS#8394
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 11, 2022
@poikilotherm
docs(releases): adapt for parent module IQSS#8394
3422d13 
As the version element has been from the WAR POM to the Parent POM and
been made flexible via the 'revision' property, the release guide needed
to be adapter accordingly.
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 11, 2022
@poikilotherm
build(war): make logging libs runtime scoped IQSS#8394
e9a97eb
pdurbin added a commit that referenced this issue Feb 14, 2022
@pdurbin
doc tweaks for #8394
488a392
poikilotherm added a commit that referenced this issue Feb 15, 2022
@poikilotherm
docs(dev): clarify nearest dependency wins #8394
73213f4
pdurbin added a commit that referenced this issue Feb 15, 2022
@pdurbin
simplify wording #8394
b63a010
pdurbin added a commit that referenced this issue Feb 15, 2022
@pdurbin
clarify dep resolution #8394
8b30406
poikilotherm added a commit to poikilotherm/dataverse that referenced this issue Feb 15, 2022
@poikilotherm
Merge pull request #524 from IQSS/8394-doc-tweaks
0682d19 
doc tweaks for IQSS#8394
pdurbin added a commit to poikilotherm/dataverse that referenced this issue Mar 4, 2022
@pdurbin
Revert "chore(jacoco): fix wrongly typed config options of JaCoCo Mav…
09167d5 
…en plugin IQSS#8394"

This reverts commit 424400b.

We believe this is causing our Jenkins job to fail. It's showing this:

[JaCoCo plugin] Overall coverage: class: 0.0, method: 0.0, line: 0.0, branch: 0.0, instruction: 0.0, complexity: 0.0

When we expect something more like this:

[JaCoCo plugin] Overall coverage: class: 73.52321, method: 46.495075, line: 41.614933, branch: 33.08663, instruction: 41.725876, complexity: 31.795692
@poikilotherm
Copy link
Contributor Author

This has been solved with the merge of #8395

@pdurbin pdurbin added this to the 5.10 milestone Mar 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Component: Code Infrastructure formerly "Feature: Code Infrastructure" Component: Containers Anything related to cloudy Dataverse, shipped in containers. Feature: Developer Guide
Projects
None yet
Milestone
5.10
Development

Successfully merging a pull request may close this issue.

8394 maven mods poikilotherm/dataverse
2 participants
@pdurbin @poikilotherm