can't release my project (sonatype) because of missing javadocs

On Sat, Feb 11, 2012 at 19:55, Kostas Kougios
wrote:
> ...and can't generate javadocs since this is a scala project.

But SBT can generate javadoc jars from ScalaDocs. You can even see
such javadoc jars coming with Scala itself.

Or I thought you could... Weird, I could swear they were there, but
they are not.

On Sat, Feb 11, 2012 at 22:42, Daniel Sobral wrote:
> On Sat, Feb 11, 2012 at 19:55, Kostas Kougios
> wrote:
>> ...and can't generate javadocs since this is a scala project.
>
> But SBT can generate javadoc jars from ScalaDocs. You can even see
> such javadoc jars coming with Scala itself.
>
> --
> Daniel C. Sobral
>
> I travel to the future all the time.

Hi Daniel, I use maven. Anyone managed to "close" a repository and
bypass the javadoc check?

On Feb 12, 12:44 am, Daniel Sobral wrote:
> Or I thought you could... Weird, I could swear they were there, but
> they are not.
>
> On Sat, Feb 11, 2012 at 22:42, Daniel Sobral wrote:
> > On Sat, Feb 11, 2012 at 19:55, Kostas Kougios
> > wrote:
> >> ...and can't generate javadocs since this is a scala project.
>
> > But SBT can generate javadoc jars from ScalaDocs. You can even see
> > such javadoc jars coming with Scala itself.
>
> > --
> > Daniel C. Sobral
>
> > I travel to the future all the time.
>
> --
> Daniel C. Sobral
>
> I travel to the future all the time.

On Sun, Feb 12, 2012 at 09:34, Kostas Kougios
wrote:
> Hi Daniel, I use maven. Anyone managed to "close" a repository and
> bypass the javadoc check?

Well, the -javadoc jars are just the contents of the doc directories
compressed with jar, so I don't see any obstable to producing that.

>
>
>
> On Feb 12, 12:44 am, Daniel Sobral wrote:
>> Or I thought you could... Weird, I could swear they were there, but
>> they are not.
>>
>> On Sat, Feb 11, 2012 at 22:42, Daniel Sobral wrote:
>> > On Sat, Feb 11, 2012 at 19:55, Kostas Kougios
>> > wrote:
>> >> ...and can't generate javadocs since this is a scala project.
>>
>> > But SBT can generate javadoc jars from ScalaDocs. You can even see
>> > such javadoc jars coming with Scala itself.
>>
>> > --
>> > Daniel C. Sobral
>>
>> > I travel to the future all the time.
>>
>> --
>> Daniel C. Sobral
>>
>> I travel to the future all the time.

Well, ofcourse probably I could fool the system, but generating javadoc
in a scala project is not standard. I could create a script to do so but
it will tie down my build process with my PC and will also need special
care each time I deploy artifacts.

Anyway, opened a jira issue on sonatype,

https://issues.sonatype.org/browse/OSSRH-2932 ,

lets see what they'll say.

Regards,

Kostas

On 12/02/12 18:11, Daniel Sobral wrote:
> On Sun, Feb 12, 2012 at 09:34, Kostas Kougios
> wrote:
>> Hi Daniel, I use maven. Anyone managed to "close" a repository and
>> bypass the javadoc check?
> Well, the -javadoc jars are just the contents of the doc directories
> compressed with jar, so I don't see any obstable to producing that.
>
>>
>>
>> On Feb 12, 12:44 am, Daniel Sobral wrote:
>>> Or I thought you could... Weird, I could swear they were there, but
>>> they are not.
>>>
>>> On Sat, Feb 11, 2012 at 22:42, Daniel Sobral wrote:
>>>> On Sat, Feb 11, 2012 at 19:55, Kostas Kougios
>>>> wrote:
>>>>> ...and can't generate javadocs since this is a scala project.
>>>> But SBT can generate javadoc jars from ScalaDocs. You can even see
>>>> such javadoc jars coming with Scala itself.
>>>> --
>>>> Daniel C. Sobral
>>>> I travel to the future all the time.
>>> --
>>> Daniel C. Sobral
>>>
>>> I travel to the future all the time.
>
>

Not true!  Generation and publishing of docs is very much the standard in sbt.

It's maven where docs aren't the status quo, not Scala.

On Feb 12, 2012 8:07 PM, "Konstantinos Kougios" <kostas.kougios@googlemail.com> wrote:

Well, ofcourse probably I could fool the system, but generating javadoc in a scala project is not standard. I could create a script to do so but it will tie down my build process with my PC and will also need special care each time I deploy artifacts.

Anyway, opened a jira issue on sonatype,

https://issues.sonatype.org/browse/OSSRH-2932  ,

lets see what they'll say.

Regards,

Kostas

On 12/02/12 18:11, Daniel Sobral wrote:

On Sun, Feb 12, 2012 at 09:34, Kostas Kougios
<kostas.kougios@googlemail.com>  wrote:

Hi Daniel, I use maven. Anyone managed to "close" a repository and
bypass the javadoc check?

Well, the -javadoc jars are just the contents of the doc directories
compressed with jar, so I don't see any obstable to producing that.

On Feb 12, 12:44 am, Daniel Sobral<dcsob...@gmail.com>  wrote:

Or I thought you could... Weird, I could swear they were there, but
they are not.

On Sat, Feb 11, 2012 at 22:42, Daniel Sobral<dcsob...@gmail.com>  wrote:

On Sat, Feb 11, 2012 at 19:55, Kostas Kougios
<kostas.koug...@googlemail.com>  wrote:

...and can't generate javadocs since this is a scala project.

But SBT can generate javadoc jars from ScalaDocs. You can even see
such javadoc jars coming with Scala itself.
--
Daniel C. Sobral
I travel to the future all the time.

--
Daniel C. Sobral

I travel to the future all the time.

On Sun, Feb 12, 2012 at 18:07, Konstantinos Kougios
wrote:
> Well, ofcourse probably I could fool the system, but generating javadoc in a
> scala project is not standard. I could create a script to do so but it will
> tie down my build process with my PC and will also need special care each
> time I deploy artifacts.

Fool the system? The javadoc jar contains the html to the docs. The
scaladoc html might not be the same html as javadoc's, but who cares?
Certainly, whatever tools use javadoc jars (IDEs, most likely) would
need ot understand scaladoc's jar, but, as it happens, they do. Well,
IntelliJ does, and Eclipse will. So, what exactly is the fooling
that's going on?

>
> Anyway, opened a jira issue on sonatype,
>
> https://issues.sonatype.org/browse/OSSRH-2932  ,
>
> lets see what they'll say.
>
> Regards,
>
> Kostas
>
>
> On 12/02/12 18:11, Daniel Sobral wrote:
>>
>> On Sun, Feb 12, 2012 at 09:34, Kostas Kougios
>>  wrote:
>>>
>>> Hi Daniel, I use maven. Anyone managed to "close" a repository and
>>> bypass the javadoc check?
>>
>> Well, the -javadoc jars are just the contents of the doc directories
>> compressed with jar, so I don't see any obstable to producing that.
>>
>>>
>>>
>>> On Feb 12, 12:44 am, Daniel Sobral  wrote:
>>>>
>>>> Or I thought you could... Weird, I could swear they were there, but
>>>> they are not.
>>>>
>>>> On Sat, Feb 11, 2012 at 22:42, Daniel Sobral  wrote:
>>>>>
>>>>> On Sat, Feb 11, 2012 at 19:55, Kostas Kougios
>>>>>  wrote:
>>>>>>
>>>>>> ...and can't generate javadocs since this is a scala project.
>>>>>
>>>>> But SBT can generate javadoc jars from ScalaDocs. You can even see
>>>>> such javadoc jars coming with Scala itself.
>>>>> --
>>>>> Daniel C. Sobral
>>>>> I travel to the future all the time.
>>>>
>>>> --
>>>> Daniel C. Sobral
>>>>
>>>> I travel to the future all the time.
>>
>>
>>
>

Ok, lets review.

I assume that scala doc is not a replacement for javadoc and having a
javadoc.jar along with your scala project is kind of a mistake (maybe a
minor one, but still is). And I can see it failing i.e. in a java+scala
project where it won't be compatible to have both scala and java docs in
the javadocs.jar (I think).

Having that in mind, is there a standard way to package scala docs with
maven? If yes and since sonatype supports scala and is now the official
repository for scala, it might make sense if they change their rules for
deploying scala artifacts, hence I opened the issue.

Also I just tried manually packing the scala doc into javadocs.jar and
maven doesn't sign it or upload it to sonatype.

Here are my artifacts:

target/mapperdao-1.0.0-rc2.jar
target/mapperdao-1.0.0-rc2-javadocs.jar
target/mapperdao-1.0.0-rc2-sources.jar

Cheers

On 12/02/12 22:37, Daniel Sobral wrote:
> On Sun, Feb 12, 2012 at 18:07, Konstantinos Kougios
> wrote:
>> Well, ofcourse probably I could fool the system, but generating javadoc in a
>> scala project is not standard. I could create a script to do so but it will
>> tie down my build process with my PC and will also need special care each
>> time I deploy artifacts.
> Fool the system? The javadoc jar contains the html to the docs. The
> scaladoc html might not be the same html as javadoc's, but who cares?
> Certainly, whatever tools use javadoc jars (IDEs, most likely) would
> need ot understand scaladoc's jar, but, as it happens, they do. Well,
> IntelliJ does, and Eclipse will. So, what exactly is the fooling
> that's going on?
>
>> Anyway, opened a jira issue on sonatype,
>>
>> https://issues.sonatype.org/browse/OSSRH-2932 ,
>>
>> lets see what they'll say.
>>
>> Regards,
>>
>> Kostas
>>
>>
>> On 12/02/12 18:11, Daniel Sobral wrote:
>>> On Sun, Feb 12, 2012 at 09:34, Kostas Kougios
>>> wrote:
>>>> Hi Daniel, I use maven. Anyone managed to "close" a repository and
>>>> bypass the javadoc check?
>>> Well, the -javadoc jars are just the contents of the doc directories
>>> compressed with jar, so I don't see any obstable to producing that.
>>>
>>>>
>>>> On Feb 12, 12:44 am, Daniel Sobral wrote:
>>>>> Or I thought you could... Weird, I could swear they were there, but
>>>>> they are not.
>>>>>
>>>>> On Sat, Feb 11, 2012 at 22:42, Daniel Sobral wrote:
>>>>>> On Sat, Feb 11, 2012 at 19:55, Kostas Kougios
>>>>>> wrote:
>>>>>>> ...and can't generate javadocs since this is a scala project.
>>>>>> But SBT can generate javadoc jars from ScalaDocs. You can even see
>>>>>> such javadoc jars coming with Scala itself.
>>>>>> --
>>>>>> Daniel C. Sobral
>>>>>> I travel to the future all the time.
>>>>> --
>>>>> Daniel C. Sobral
>>>>>
>>>>> I travel to the future all the time.
>>>
>>>
>
>

Konstantinos Kougios wrote:
> Well, ofcourse probably I could fool the system, but generating javadoc
> in a scala project is not standard. I could create a script to do so but
> it will tie down my build process with my PC and will also need special
> care each time I deploy artifacts.
>
> Anyway, opened a jira issue on sonatype,
>
> https://issues.sonatype.org/browse/OSSRH-2932 ,
>
> lets see what they'll say.

FWIW, this is along the lines of what

suggests:

"Sources and Javadoc: If, for some reason (for example, license issue or
it's a Scala project), you can not provide -sources.jar or -javadoc.jar,
please leave a comment on your JIRA ticket, so the repository
administrator can remove the restriction for you."

Hope this helps.

Andreas

Hi Andreas, yes I've noticed that and posted it to my oss Jira but I
was adviced for now to just put a fake javadoc which I did and finally
managed to deploy.

https://issues.sonatype.org/browse/OSSRH-2908?page=com.atlassian.jira.pl...

I'm creating the javadoc by having a no-op java class in my scala
project, otherwise maven doesn't generate or gpg-sign or uploads a
fake javadoc.

Happy that deployed the artifacts yesterday. Looking forward into the
future, though it is not of big importance for the quality of an
opensource project, I believe since sonatype is the main scala
repository, there should be a way to upload scala doc jars and also
pass the sonatype rules.

For those wanting to deploy in sonatype, you could do as I did, just
place a dummy java class and then follow the sonatype instructions. As
an example pom, you can check

http://code.google.com/p/mapperdao/source/browse/trunk/pom.xml

On Feb 14, 9:03 am, Andreas Sewe
wrote:
> Konstantinos Kougios wrote:
> > Well, ofcourse probably I could fool the system, but generating javadoc
> > in a scala project is not standard. I could create a script to do so but
> > it will tie down my build process with my PC and will also need special
> > care each time I deploy artifacts.
>
> > Anyway, opened a jira issue on sonatype,
>
> >https://issues.sonatype.org/browse/OSSRH-2932 ,
>
> > lets see what they'll say.
>
> FWIW, this is along the lines of what
>
> suggests:
>
> "Sources and Javadoc: If, for some reason (for example, license issue or
> it's a Scala project), you can not provide -sources.jar or -javadoc.jar,
> please leave a comment on your JIRA ticket, so the repository
> administrator can remove the restriction for you."
>
> Hope this helps.
>
> Andreas

The Maven plugin supports scaladoc as well, you just have to configure it in.

On Sun, Feb 12, 2012 at 6:34 AM, Kostas Kougios <kostas.kougios@googlemail.com> wrote:

Hi Daniel, I use maven. Anyone managed to "close" a repository and
bypass the javadoc check?



On Feb 12, 12:44 am, Daniel Sobral <dcsob...@gmail.com> wrote:
> Or I thought you could... Weird, I could swear they were there, but
> they are not.
>
> On Sat, Feb 11, 2012 at 22:42, Daniel Sobral <dcsob...@gmail.com> wrote:
> > On Sat, Feb 11, 2012 at 19:55, Kostas Kougios
> > <kostas.koug...@googlemail.com> wrote:
> >> ...and can't generate javadocs since this is a scala project.
>
> > But SBT can generate javadoc jars from ScalaDocs. You can even see
> > such javadoc jars coming with Scala itself.
>
> > --
> > Daniel C. Sobral
>
> > I travel to the future all the time.
>
> --
> Daniel C. Sobral
>
> I travel to the future all the time.

I've used scala:doc but it doesn't generate a jar to be uploaded when 'mvn deploy' and I can't find any option to do so at

http://scala-tools.org/mvnsites/maven-scala-plugin/usage_doc.html

Is there an option to jar the doc contents and deploy them? Do you have a sample pom I can view?

Thanks

On 14/02/12 23:01, Josh Suereth wrote:

CAFLqJkxdhp381em_2EpANvgcGWqdu4COGpJQ2R42bRzDG8H66A [at] mail [dot] gmail [dot] com" type="cite">The Maven plugin supports scaladoc as well, you just have to configure it in.

On Sun, Feb 12, 2012 at 6:34 AM, Kostas Kougios <kostas [dot] kougios [at] googlemail [dot] com" rel="nofollow">kostas.kougios@googlemail.com> wrote:

Hi Daniel, I use maven. Anyone managed to "close" a repository and
bypass the javadoc check?



On Feb 12, 12:44 am, Daniel Sobral <dcsob [dot] [dot] [dot] [at] gmail [dot] com" rel="nofollow">dcsob...@gmail.com> wrote:
> Or I thought you could... Weird, I could swear they were there, but
> they are not.
>
> On Sat, Feb 11, 2012 at 22:42, Daniel Sobral <dcsob [dot] [dot] [dot] [at] gmail [dot] com" rel="nofollow">dcsob...@gmail.com> wrote:
> > On Sat, Feb 11, 2012 at 19:55, Kostas Kougios
> > <kostas [dot] koug [dot] [dot] [dot] [at] googlemail [dot] com" rel="nofollow">kostas.koug...@googlemail.com> wrote:
> >> ...and can't generate javadocs since this is a scala project.
>
> > But SBT can generate javadoc jars from ScalaDocs. You can even see
> > such javadoc jars coming with Scala itself.
>
> > --
> > Daniel C. Sobral
>
> > I travel to the future all the time.
>
> --
> Daniel C. Sobral
>
> I travel to the future all the time.

Hmm, right.   We never implemented https://github.com/davidB/maven-scala-plugin/issues/68
I'll see if I can work that up for you this week.  I'll put it next on the queue.
- Josh

On Tue, Feb 14, 2012 at 6:06 PM, Konstantine Kougios <kostas.kougios@googlemail.com> wrote:

I've used scala:doc but it doesn't generate a jar to be uploaded when 'mvn deploy' and I can't find any option to do so at

http://scala-tools.org/mvnsites/maven-scala-plugin/usage_doc.html

Is there an option to jar the doc contents and deploy them? Do you have a sample pom I can view?

Thanks

On 14/02/12 23:01, Josh Suereth wrote:

The Maven plugin supports scaladoc as well, you just have to configure it in.

On Sun, Feb 12, 2012 at 6:34 AM, Kostas Kougios <kostas.kougios@googlemail.com> wrote:

Hi Daniel, I use maven. Anyone managed to "close" a repository and
bypass the javadoc check?



On Feb 12, 12:44 am, Daniel Sobral <dcsob...@gmail.com> wrote:
> Or I thought you could... Weird, I could swear they were there, but
> they are not.
>
> On Sat, Feb 11, 2012 at 22:42, Daniel Sobral <dcsob...@gmail.com> wrote:
> > On Sat, Feb 11, 2012 at 19:55, Kostas Kougios
> > <kostas.koug...@googlemail.com> wrote:
> >> ...and can't generate javadocs since this is a scala project.
>
> > But SBT can generate javadoc jars from ScalaDocs. You can even see
> > such javadoc jars coming with Scala itself.
>
> > --
> > Daniel C. Sobral
>
> > I travel to the future all the time.
>
> --
> Daniel C. Sobral
>
> I travel to the future all the time.

Thanks Josh

On 14/02/12 23:14, Josh Suereth wrote:

CAFLqJkwscEZ8BpCWY2yCOPBGoKKmo22ZEBdJ0ijTw4g1bFGLJA [at] mail [dot] gmail [dot] com" type="cite">Hmm, right.   We never implemented https://github.com/davidB/maven-scala-plugin/issues/68
I'll see if I can work that up for you this week.  I'll put it next on the queue.
- Josh

On Tue, Feb 14, 2012 at 6:06 PM, Konstantine Kougios <kostas [dot] kougios [at] googlemail [dot] com" rel="nofollow">kostas.kougios@googlemail.com> wrote:

I've used scala:doc but it doesn't generate a jar to be uploaded when 'mvn deploy' and I can't find any option to do so at

http://scala-tools.org/mvnsites/maven-scala-plugin/usage_doc.html

Is there an option to jar the doc contents and deploy them? Do you have a sample pom I can view?

Thanks

On 14/02/12 23:01, Josh Suereth wrote:

The Maven plugin supports scaladoc as well, you just have to configure it in.

On Sun, Feb 12, 2012 at 6:34 AM, Kostas Kougios <kostas [dot] kougios [at] googlemail [dot] com" target="_blank" rel="nofollow">kostas.kougios@googlemail.com> wrote:

Hi Daniel, I use maven. Anyone managed to "close" a repository and
bypass the javadoc check?



On Feb 12, 12:44 am, Daniel Sobral <dcsob [dot] [dot] [dot] [at] gmail [dot] com" target="_blank" rel="nofollow">dcsob...@gmail.com> wrote:
> Or I thought you could... Weird, I could swear they were there, but
> they are not.
>
> On Sat, Feb 11, 2012 at 22:42, Daniel Sobral <dcsob [dot] [dot] [dot] [at] gmail [dot] com" target="_blank" rel="nofollow">dcsob...@gmail.com> wrote:
> > On Sat, Feb 11, 2012 at 19:55, Kostas Kougios
> > <kostas [dot] koug [dot] [dot] [dot] [at] googlemail [dot] com" target="_blank" rel="nofollow">kostas.koug...@googlemail.com> wrote:
> >> ...and can't generate javadocs since this is a scala project.
>
> > But SBT can generate javadoc jars from ScalaDocs. You can even see
> > such javadoc jars coming with Scala itself.
>
> > --
> > Daniel C. Sobral
>
> > I travel to the future all the time.
>
> --
> Daniel C. Sobral
>
> I travel to the future all the time.