Skip to content

Idea: warn if the package archive contains documentation #521

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

Closed
isoos opened this issue Mar 6, 2019 · 4 comments
Closed

Idea: warn if the package archive contains documentation #521

isoos opened this issue Mar 6, 2019 · 4 comments

Comments

@isoos
Copy link
Collaborator

isoos commented Mar 6, 2019

The root cause of dart-lang/pub-dev#2104 is that the package archive contains the documentation, e.g. in this directory both lowercase and uppercase quickReplies.html is present.

Besides the chance of name collision of Windows filesystem, it is an extra content that should not be part of the package (e.g. most users won't check and see the documentation that way).

Should we add e.g. a -30 penalty for it? /cc @jonasfj

@jonasfj
Copy link
Member

jonasfj commented Mar 8, 2019

No, I think it's better to warn when publishing in pub client... It should be easy to check if the doc/api/ folder contains an index.html file...

This is something people want to notice before they publish :) hehe

@jonasfj jonasfj closed this as completed Mar 8, 2019
@jonasfj
Copy link
Member

jonasfj commented Mar 8, 2019

Actually, @sigurdm, thoughts? :) hehe

@sigurdm
Copy link
Contributor

sigurdm commented Mar 8, 2019

Ideally I think we should not be able to commit (or at least warn when we try) from an unclean git repo.
That would help on this as well.

@sigurdm
Copy link
Contributor

sigurdm commented Mar 8, 2019

I think we should also warn (when publishing) about docs as jonas suggested.
And the warning could have a suggestion to add something nice to your .gitignore.

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

No branches or pull requests

3 participants