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

Move the package description limit in HISTORY.md #8097

Merged
merged 1 commit into from Nov 13, 2023

Conversation

dmontagu
Copy link
Contributor

@dmontagu dmontagu commented Nov 13, 2023

(Hopefully?) closes #8096

The package description limit used to be placed at the last commit before the first v1 beta release, seems reasonable to me to move that to the last commit before the first v2 alpha release.

Seems to be kind of a bandaid, as ideally we'd have a way to fail in CI if the description gets too long, but this seems like a reasonable short term solution. (Though at the current rate of bugfixes/etc. it probably won't last as long as the last update did.)

I'm not sure how to tell how many bytes the description would be after trimming at the package description limit, because the markdown file itself is smaller than the error number I saw in #8096, but probably there is some way to get a proxy that's close enough. But, assuming this works, I think we should just merge this unless someone can put together a better solution in time for a 2.5.1 release.

@dmontagu dmontagu added the relnotes-ignore Omit this PR from the release notes. label Nov 13, 2023
@dmontagu dmontagu changed the title Move the description limit Move the package description limit in HISTORY.md Nov 13, 2023
Copy link

codspeed-hq bot commented Nov 13, 2023

CodSpeed Performance Report

Merging #8097 will not alter performance

Comparing update-package-description-limit (779f8d7) with main (4a2a5bb)

Summary

✅ 10 untouched benchmarks

Copy link
Member

@sydney-runkle sydney-runkle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, definitely a bandaid fix, but one that we need 🩹 !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
relnotes-ignore Omit this PR from the release notes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Pydantic v2.5.0 breaking installs due to size of Description
2 participants