erlef / rebar3_hex

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

Add --without-docs option for publish task #210

Closed starbelly closed 3 years ago

starbelly commented 3 years ago
starbelly commented 3 years ago

Logic is sound.

Would it make sense to have it as --with-docs=true|false and defaulting to true, so that instead of writing --without-docs=true you just write --with-docs=false (or maybe even just --docs)

We could go that route, but you don't have to specify --without-docs=true, just --without-docs. The idea being you'll only ever use that switch if you want it on. Does that make sense?

Edit:

Example output:

===> Analyzing applications...
===> Compiling rebar3_hex
===> Analyzing applications...
===> Compiling rebar3_hex
===> Verifying dependencies...
Publishing truecoat 0.42.42 to hexpm
  Description: It gets installed at the factory
  Dependencies:

  Included files:
    CHANGELOG.md
    LICENSE
    README.md
    rebar.config
    rebar.lock
    src/truecoat.app.src
    src/truecoat.erl
  Licenses: Apache 2.0
  Links:

  Build tools: rebar3
Be aware, you are publishing to the public Hexpm repository.
Before publishing, please read Hex CoC: https://hex.pm/policies/codeofconduct
Proceed? ("Y")> y
Local Password:
===> Published truecoat 0.42.42
===> --without-docs is enabled : will not publish docs
ferd commented 3 years ago

Yeah that's fine too