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

There should be section about checking your package before publishing it using pana #6074

Open
1 task
csells opened this issue Sep 3, 2024 · 0 comments
Open
1 task
Labels
d.enhancement Improves docs with specific ask dev.packages Relates to package publishing e1-hours Can complete in < 8 hours of normal, not dedicated, work from.page-issue Reported in a reader-filed concern p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface.

Comments

@csells
Copy link

csells commented Sep 3, 2024

Page URL

https://dart.dev/tools/pub/publishing/

Page source

https://github.com/dart-lang/site-www/tree/main/src/content/tools/pub/publishing.md

Describe the problem

I went looking for the pana tool because I couldn't remember what it was called. I wanted to check my package before I published it to ensure I had a high pub points score, that I was reporting all of the platforms that were supported, I had good API docs coverage, etc.

Expected fix

there should be docs that encourage folks to use pana on their package before they publish it; they'll catch all kinds of errors that way and save them from getting errors that kick their package back or being surprised as to what pub.dev says about their package.

Additional context

pana is essentially a pre-publishing tool for package authors and we should be recommending everyone use it as part of their publishing process. and it's owned and maintained by the Dart Tools team, so there's no excuse for us not to encourage folks to use it.

I would like to fix this problem.

  • I will try and fix this problem on dart.dev.

note: please excuse the use of the term "we" to imply my inclusion in the Dart/Flutter team. I still think of myself that way. : )

@csells csells added the from.page-issue Reported in a reader-filed concern label Sep 3, 2024
@parlough parlough added d.enhancement Improves docs with specific ask p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. e1-hours Can complete in < 8 hours of normal, not dedicated, work dev.packages Relates to package publishing labels Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
d.enhancement Improves docs with specific ask dev.packages Relates to package publishing e1-hours Can complete in < 8 hours of normal, not dedicated, work from.page-issue Reported in a reader-filed concern p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface.
Projects
None yet
Development

No branches or pull requests

2 participants