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

Update paths and add maven build system #1

Merged
merged 18 commits into from
Oct 11, 2016
Merged

Update paths and add maven build system #1

merged 18 commits into from
Oct 11, 2016

Conversation

rleigh-codelibre
Copy link
Contributor

@rleigh-codelibre rleigh-codelibre commented Oct 10, 2016

The aim of this PR is to take the result of git filter-branch in ome-common-java, which is currently not buildable, and to make it build and test with maven, and also do the same driven by travis. This will get the repository functional and testable so that this basic infrastructure will be in place for future PRs.

  • Use standard maven path layout
  • Drop ant build
  • Add travis support for maven build only
  • Make maven build work again
  • Update licence and readme

NB. maven builds needs further work either in this PR or as a followup. The pom.xml is an aggregate of the logic in components/formats-common and the toplevel. Some of the logic is redundant, and some is likely outdated and unnecessary.


<groupId>org.openmicroscopy</groupId>
<artifactId>ome-common</artifactId>
<version>6.0.0-SNAPSHOT</version>
Copy link
Member

Choose a reason for hiding this comment

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

One question here is whether we should not be conservative and target this as 5.3.0-SNAPSHOT. As far as I know, our first target is a Maven release with no API change and for consumers the major change is the usage of a different groupId/artifactId (and only if they are declaring it directly in their POM).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This would certainly make sense.

@rleigh-codelibre rleigh-codelibre changed the title Update paths Update paths and add maven build system Oct 10, 2016
Copy link
Member

@sbesson sbesson left a comment

Choose a reason for hiding this comment

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

Discussed with @rleigh-codelibre, there are a couple of follow-up items after this PR. Some of them are commented inline. In addition, we might want to restore findbugs:checkand activatejavadoc` in the Travis build but both additions will require some code adjustements and should be carried out separately. Fixing these could be natural targets for a 5.3.1 release.

Any other comment/thought/suggestion @melissalinkert @joshmoore @mtbc

build
components/*/utils/*.class
emailable-report.html
index.html
target
Copy link
Member

Choose a reason for hiding this comment

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

Is target actually used at all, it might be another legacy of the Ant system.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's created by maven; all the generated classes, docs, test results etc. go under here.

Copy link
Member

Choose a reason for hiding this comment

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

Understood, ignore my comment then.

</scm>

<repositories>
<repository>
Copy link
Member

Choose a reason for hiding this comment

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

We might want to remove the OME artifactory links here as nothing should depend on them?

</snapshotRepository>
</distributionManagement>

<developers>
Copy link
Member

Choose a reason for hiding this comment

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

The developers list might require a review in a follow-up PR.

@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
Copy link
Member

Choose a reason for hiding this comment

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

👍 for restoring this in the correct place as logback initialization is required for some of the DebugToolsTest unit tests

@sbesson sbesson added this to the 5.3.0 milestone Oct 10, 2016
</plugin>

<plugin>
<artifactId>maven-jar-plugin</artifactId>
Copy link
Member

@sbesson sbesson Oct 11, 2016

Choose a reason for hiding this comment

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

Tested the integration of this component into Bio-Formats on top of ome/bioformats#2608. Looking at the difference between the content of formats-common-5.2.3.jar and ome-common-5.3.0-SNAPSHOT.jar, except for META-INF, the only missing file is service.properties which is currently required for using the services.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is now added.

@rleigh-codelibre
Copy link
Contributor Author

This PR can be tested functionally using https://github.com/rleigh-codelibre/bioformats/tree/common-split

Run mvn install for this repository, then check out this branch in bioformats.git and then run ant or mvn and it will use the ome-common jar for building and testing.

@sbesson
Copy link
Member

sbesson commented Oct 11, 2016

Thanks for the instructions. Using the HEAD of this PR and building successfully ome-common-java and bioformats with the branch above worked as expected (build + unit tests using Maven). Merging.

@sbesson sbesson merged commit 9ff60b4 into ome:master Oct 11, 2016
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.

2 participants