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

Cleanup in fcrepo-http-api #835

Closed
wants to merge 6 commits into from

Conversation

Projects
None yet
2 participants
@ajs6f
Copy link
Contributor

commented Jul 12, 2015

@awoods

This comment has been minimized.

Copy link
Member

commented Jul 13, 2015

It looks like Travis is failing with javadoc errors:
(mvn javadoc:test-aggregate)
https://s3.amazonaws.com/archive.travis-ci.org/jobs/70637161/log.txt

@ajs6f

This comment has been minimized.

Copy link
Contributor Author

commented Jul 13, 2015

Fixed, I think. Try again.

@awoods

This comment has been minimized.

Copy link
Member

commented Jul 13, 2015

Now Travis is saying there is a checkstyle error:
https://s3.amazonaws.com/archive.travis-ci.org/jobs/70794854/log.txt

Before submitting a PR, I would suggest running the following three commands:

  • mvn clean install
  • mvn javadoc:jar
  • mvn javadoc:test-aggregate
@ajs6f

This comment has been minimized.

Copy link
Contributor Author

commented Jul 14, 2015

If that is the normal build check set, you need to actually key that into Maven. It's not hard to do that. Most people are going to expect that mvn clean install will be enough, and they're right.

@awoods

This comment has been minimized.

Copy link
Member

commented Jul 14, 2015

@ajs6f, the history here is that we used to have the javadoc plugin activated by default in the top-level pom.xml. Then, since we did not want to generate javadocs on each build, we moved the plugin into the release profile. Then, when we moved to Java8, javadoc errors became strictly enforced.
The way our pom.xml is currently set up is to only run javadocs at release-time, therefore only showing errors at release-time... which does not make for a smooth release.
Therefore, we enabled Travis to run the javadoc commands that I mentioned above to strike a middle ground: users not having to build javadocs on every build, but the issues being caught before release.

I am happy to make changes if you have a suggestion, however.

@ajs6f

This comment has been minimized.

Copy link
Contributor Author

commented Jul 14, 2015

We moved the Javadoc step out because it wasn't needed to build and took time. Now it is needed to build, so either we should stop strictly enforcing the Javadocs rules or it should be run for verify.

@awoods

This comment has been minimized.

Copy link
Member

commented Jul 14, 2015

Sounds good. Please create a ticket to re-add javadoc in the build process.

@ajs6f

This comment has been minimized.

Copy link
Contributor Author

commented Jul 14, 2015

@awoods

This comment has been minimized.

Copy link
Member

commented Jul 14, 2015

Resolved with:
43c3b3a and
31c1f11 and
7141787

@awoods awoods closed this Jul 14, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.