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

Output when missing Hex doc configuration could be improved #263

Closed
eproxus opened this issue Dec 9, 2021 · 2 comments · Fixed by #264
Closed

Output when missing Hex doc configuration could be improved #263

eproxus opened this issue Dec 9, 2021 · 2 comments · Fixed by #264

Comments

@eproxus
Copy link

eproxus commented Dec 9, 2021

Currently, in projects with "legacy" configuration (no {hex, [{doc, ...}]} configuration the following output is generated when running rebar3 hex and rebar3 hex docs:

$ rebar3 hex docs
===> Verifying dependencies...
===> No valid hex docs configuration found. Docs will will not be generated
Local Password:
===> Published docs for grisp 2.0.0-rc1

I think it is confusing because the "No valid hex docs..." line is red and seems to indicate an error, an then the docs are published anyway (most likely stale since the plug-in will no longer re-generate the docs without the correct undocumented configuration).

@starbelly
Copy link
Member

starbelly commented Dec 9, 2021

Right, what we can do here for v6.11.x is check to see if there's doc provider config, but then also check to see if there's a doc dir with at least an index file in it, if so, then don't warn.

Likewise, we should omit "Published docs..." if either of the above don't hold true.

@starbelly
Copy link
Member

@eproxus Merged bug fix and published v6.11.8 to hex.pm . Closing this as resolved.

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 a pull request may close this issue.

2 participants