Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve UX for warnings arounds doc config and generation #264

Merged
merged 1 commit into from
Dec 11, 2021

Conversation

starbelly
Copy link
Member

This PR closes #263

With a doc directory that contains an index.html file but no doc provider configuration :

Publishing truecoat 0.4.56 to hexpm
  Description: It gets installed at the factory
  Dependencies:

  Included files:
    LICENSE
    README.md
    rebar.config
    rebar.lock
    something_else/foo
    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")>
Local Password:
===> Published truecoat 0.4.56
===> Published docs for truecoat 0.4.56

Without doc provider configuration and no doc dir with an index.html file found :

Publishing truecoat 0.4.59 to hexpm
  Description: It gets installed at the factory
  Dependencies:

  Included files:
    LICENSE
    README.md
    rebar.config
    rebar.lock
    something_else/foo
    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")>
Local Password:
===> Published truecoat 0.4.59
===> No valid hex docs configuration found. Docs will will not be generated.
===> Docs were not published since they couldn't be found in '/Users/starbelly/devel/erlang/truecoat/doc'. Please build the docs and then run `rebar3 hex docs` to publish them.

@starbelly starbelly linked an issue Dec 11, 2021 that may be closed by this pull request
@starbelly starbelly requested a review from ferd December 11, 2021 19:52
@starbelly starbelly merged commit 71cb75c into erlef:v6.11 Dec 11, 2021
@starbelly starbelly deleted the fixup-publish-docs-output branch December 24, 2021 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Output when missing Hex doc configuration could be improved
2 participants