search

erlef / rebar3_hex

Rebar3 Hex library
Apache License 2.0
101 stars 49 forks source link

Remind users to upload docs after publishing #24

Closed ericmj closed 4 years ago

starbelly commented 5 years ago

Hmm, this is an old issue... I don't think hex reminds you to publish docs? I can't remember, but didn't see any related code for that. It looked like in hex you either explicitly specify the package and it publishes, without a reminder... or it tries to build the docs, publish the package, and the docs... is that correct @ericmj ?

tsloughter commented 5 years ago

mix hex will always publish the docs when publishing a package.

starbelly commented 5 years ago

@tsloughter hmmm... that's not what I thought I saw... but gonna go with my eyes were deceiving me. Either way, should we follow suite? Is there a reason we do not yet?

tsloughter commented 5 years ago

Reason I didn't was that so many erlang projects likely fail when edoc is run on them.

But it might be a good idea since it happens after the initial publishing of the package, so it won't block publishing. It will just ensure that if docs are able to be built they get published too.

starbelly commented 5 years ago

Right, we are on the same page 👍

ericmj commented 5 years ago

@tsloughter is correct. mix hex.publish will publish both package and docs, and will stop the publish if it fails to build the docs. mix hex.publish package publishes only package, mix hex.publish docs publishes only docs (useful when doing docs fixes after publishing).

starbelly commented 5 years ago

@ericmj aye... though I don't think it's a good idea to let @tsloughter know he's correct.