Skip to content
This repository has been archived by the owner on Jan 18, 2021. It is now read-only.

Start shipping Javadoc #233

Closed
mockitoguy opened this issue Jun 13, 2017 · 7 comments
Closed

Start shipping Javadoc #233

mockitoguy opened this issue Jun 13, 2017 · 7 comments
Assignees
@mockitoguy @mstachniuk
Milestone
Shipkit for new c...

Comments

@mockitoguy
Copy link
Member

mockitoguy commented Jun 13, 2017 •
edited

Problem

Currently, we rely on external https://javadoc.io service to host viewable Javadoc. When we publish the jars with javadocs to Maven Central, the javadoc is automatically downloaded, unzipped and hosted at javadoc.io. This works well for projects that ship to Central. Projects that don't ship to Central (some project ship only to https://bintray.com) don't get this benefit. Best example is Shipkit project itself - currently we don't host unzipped Javadocs that are easy to view online.

Design spec

See PR #697
@mockitoguy
Copy link
Member Author

@mstachniuk, do you want to scope this ticket a bit more? I can help if needed :)

@mstachniuk
Copy link
Contributor

I will do after a long weekend.

@mstachniuk mstachniuk self-assigned this Jun 15, 2017
@mockitoguy
Copy link
Member Author

@mstachniuk, how's life? Will you be able to take a stab at this feature? Cheers!

@mockitoguy mockitoguy added this to the Automatically Publish Javadoc milestone Mar 18, 2018
@mockitoguy mockitoguy self-assigned this Mar 18, 2018
@mockitoguy mockitoguy modified the milestones: Automatically Publish Javadoc, Support Circle CI Mar 18, 2018
@mockitoguy
Copy link
Member Author

I worked on designing the plugin today and added a pseudo code design to the description. Hope it helps!

@mstachniuk
Copy link
Contributor

@mockitoguy Sure, it will help me. Thank you!

@mockitoguy
Copy link
Member Author

@mstachniuk, the design spec is ready #697 :)

@mockitoguy mockitoguy mentioned this issue Apr 10, 2018
Merged
mstachniuk added a commit that referenced this issue Feb 6, 2019
@mstachniuk
Start shipping Javadoc #233
daa84f8 
Configuration, clone checkout Javadoc repo, copy javadocs to stage dir
mstachniuk added a commit that referenced this issue Feb 8, 2019
@mstachniuk
Start shipping Javadoc #233
6452d95 
Tasks: commitJavadoc, pushJavadoc, releaseJavadoc
@mstachniuk mstachniuk mentioned this issue Feb 24, 2019
Merged
@mstachniuk mstachniuk mentioned this issue Mar 3, 2019
Merged
@mstachniuk
Copy link
Contributor

It's in progress...

@mstachniuk mstachniuk mentioned this issue Mar 5, 2019
Open
mstachniuk added a commit that referenced this issue Mar 6, 2019
@mstachniuk
Start shipping Javadoc #233
b8a2ded 
Configuration, clone checkout Javadoc repo, copy javadocs to stage dir
mstachniuk added a commit that referenced this issue Mar 6, 2019
@mstachniuk
Start shipping Javadoc #233
98322a0 
Tasks: commitJavadoc, pushJavadoc, releaseJavadoc
mstachniuk added a commit that referenced this issue Mar 6, 2019
@mstachniuk
#233 Redesign configuration for Javadoc, commitJavadoc task works
67ef1f9
mstachniuk added a commit that referenced this issue Mar 9, 2019
@mstachniuk
Fix #233 Start shipping Javadoc
353fba3
mstachniuk added a commit that referenced this issue Mar 11, 2019
@mstachniuk
Start shipping Javadoc #233
def4710 
Configuration, clone checkout Javadoc repo, copy javadocs to stage dir
mstachniuk added a commit that referenced this issue Mar 11, 2019
@mstachniuk
Start shipping Javadoc #233
ec993ab 
Tasks: commitJavadoc, pushJavadoc, releaseJavadoc
mstachniuk added a commit that referenced this issue Mar 11, 2019
@mstachniuk
#233 Redesign configuration for Javadoc, commitJavadoc task works
98c4b11
mstachniuk added a commit that referenced this issue Mar 12, 2019
@mstachniuk
Fix #233 Start shipping Javadoc
4e4e09b
mstachniuk added a commit that referenced this issue Mar 13, 2019
@mstachniuk
Fix #233 Start shipping Javadoc, Code review changes
adc39b0
@mstachniuk mstachniuk mentioned this issue Mar 16, 2019
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@mockitoguy mockitoguy

@mstachniuk mstachniuk

Labels
None yet
Projects
None yet
Milestone
Shipkit for new customers (18Q2)
Development

No branches or pull requests
2 participants
@mockitoguy @mstachniuk