Skip to content

Feature Request: Prevent score regression on publishing #232

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

Open
lucasavila00 opened this issue Mar 7, 2024 · 2 comments
Open

Feature Request: Prevent score regression on publishing #232

lucasavila00 opened this issue Mar 7, 2024 · 2 comments

Comments

@lucasavila00
Copy link

lucasavila00 commented Mar 7, 2024

Thanks for building jsr, I loved the score feature.

I wonder if the CLI could prevent score regressions, or prevent publishing if certain requirements are not met.

For instance, I have a published package where all symbols have documentation and all entry points have documentation. I would like it to continue to have the docs for all symbols, but I can see myself forgetting to add them.

So, I'm proposing the CLI add a mechanism to either prevent score decrease or a --require-docs-percentage 100 parameter. This would work similarly to test coverage tools.

@github-project-automation github-project-automation bot moved this to Needs Triage in JSR Mar 7, 2024
@lucasavila00
Copy link
Author

Related: #199

@lucacasonato lucacasonato moved this from Needs Triage to Ready in JSR Mar 11, 2024
@lucacasonato lucacasonato moved this from Ready to Needs Plan in JSR Mar 11, 2024
@crowlKats crowlKats removed the feature label Jan 17, 2025
@lucacasonato
Copy link
Member

The real solution would be to compute the score locally and check (see #199). For now we are thinking we can just upload this flag together with the publish tarball when a user runs jsr publish and then check server-side. If the docs percentage (or other parts of the score) are not high enough, we can just fail the publish and the user can try again.

@lucacasonato lucacasonato moved this from Needs Plan to Ready in JSR May 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Ready
Development

No branches or pull requests

3 participants