scalaz / ioeffect

An effect monad for Scalaz 7.2
Other
55 stars 9 forks source link

scaladoc is empty #20

Closed xuwei-k closed 6 years ago

xuwei-k commented 6 years ago

🤔 ?

$ wget https://oss.sonatype.org/content/repositories/releases/org/scalaz/scalaz-ioeffect_2.12/2.0.0/scalaz-ioeffect_2.12-2.0.0-javadoc.jar
$ unzip -Z scalaz-ioeffect_2.12-2.0.0-javadoc.jar 
Archive:  scalaz-ioeffect_2.12-2.0.0-javadoc.jar
Zip file size: 189 bytes, number of entries: 1
-rw----     2.0 fat       25 bX defN 18-Apr-20 23:16 META-INF/MANIFEST.MF
1 file, 25 bytes uncompressed, 27 bytes compressed:  -8.0%
fommil commented 6 years ago

not a bug, intentional. sbt-sensible does this in https://gitlab.com/fommil/sbt-sensible/blob/v2.4.4/src/main/scala/SensiblePlugin.scala#L62

(nobody reads docs, and this dramatically speeds up the release)

fommil commented 6 years ago

I'd also be happy just not publishing docs... but I think sonatype complains if I do that. I may be wrong.

fommil commented 6 years ago

I did an experiment (in another project) and if I disable docs with

publishArtifact in (Compile, packageDoc) := false,

I get this when I close the repository

Event: Failed: Javadoc Validation
Saturday, April 21, 2018 16:06:14 BST (GMT+0100)

typeId  javadoc-staging
failureMessage  Missing: no javadoc jar found in folder '/com/fommil/scalaz-deriving-base_2.12/0.13.2'
failureMessage  Missing: no javadoc jar found in folder '/com/fommil/deriving-macro_2.12/0.13.2'
failureMessage  Missing: no javadoc jar found in folder '/com/fommil/xmlformat_2.12/0.13.2'
failureMessage  Missing: no javadoc jar found in folder '/com/fommil/deriving-plugin_2.12/0.13.2'
failureMessage  Missing: no javadoc jar found in folder '/com/fommil/scalaz-deriving_2.12/0.13.2'

which is why I publish empty docs.

fommil commented 6 years ago

heh. Independently discovered in https://github.com/xerial/sbt-sonatype/issues/30

fommil commented 6 years ago

I raised a ticket https://issues.sonatype.org/browse/OSSRH-39300