spotify / completable-futures

Utilities for working with futures in Java 8
Apache License 2.0
393 stars 51 forks source link

Generate Maven site and deploy to gh-pages #42

Closed dflemstr closed 8 years ago

dflemstr commented 8 years ago

This creates a Maven site for the project and deploys it to http://spotify.github.io/completable-futures. I didn't add a lot of stuff there; maybe a next step could be to include the README in there too or something.

Maybe most importantly it makes Javadoc available at http://spotify.github.io/completable-futures/apidocs (or http://spotify.github.io/completable-futures/apidocs/com/spotify/futures/CompletableFutures.html) which makes it easier to give people links to the documentation.

I took the liberty to deploy the site from my local machine so that the links above actually work, and set up Travis so that everything should Just Work® when this is merged.

PS. I set this up for this repo in particular because I think we should have Maven sites for all of our Java projects, and this was the smallest project we have in the Spotify org that would let me field test the configuration.

mbruggmann commented 8 years ago

Good idea! Looks a bit weird on my phone though:

site-mobile

In any case, I'm fine with merging it to get us started with something.

codecov-io commented 8 years ago

Current coverage is 100%

Merging #42 into master will not change coverage

@@            master       #42   diff @@
========================================
  Files            4         4          
  Lines           61        51    -10   
  Methods          0         0          
  Messages         0         0          
  Branches         3         3          
========================================
- Hits            61        51    -10   
  Misses           0         0          
  Partials         0         0          
  1. File ...pletableFutures.java (not in diff) was modified. more
    • Misses 0
    • Partials 0
    • Hits -10

Powered by Codecov. Last updated by ec9cba9...e89c86e

econchick commented 8 years ago

I see this is a static site - might I suggest you redirect http->https? we did it for the spotify.github.io site with this commit.

dflemstr commented 8 years ago

@econchick see https://github.com/spotify/completable-futures/pull/46