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

Release process fails if release notes created by auto grow too big #2418

Open
LittleGreenYoda42 opened this issue Jan 4, 2024 · 2 comments
Labels
bug Something isn't working

Comments

@LittleGreenYoda42
Copy link
Contributor

Describe the bug

When auto creates a new release it also creates release notes from all changes which happened since the last release.
If a lot of changes have happened since the last release, those release notes can grow very big.

There is a character limit for a release to be created via the GitHub API of 125000 characters.

The result of too many changes is

Validation Failed: {"resource":"Release","code":"custom","field":"body","message":"body is too long (maximum is 125000 characters)"}

There is no option to make auto truncate the release notes if this happens. The workaround I used was to create a release manually and with that the changes since the last release to be used for the new auto release were small enough for it to work again.

To Reproduce

Create a lot of commits in a repo which are not released and then try to release with auto shipit.

Expected behavior

Some way to configure auto to not use the whole generated release notes for the GitHub release in case it gets to big. Another option would be that by default the release notes are truncated if they grow too big.

Screenshots

Environment information:

"auto" version: v11.0.4
"git"  version: v2.43.0
"node" version: v18.19.0

Additional context

@LittleGreenYoda42 LittleGreenYoda42 added the bug Something isn't working label Jan 4, 2024
@yarikoptic
Copy link

I think this is likely at large a duplicate of "good old" #1294

@hipstersmoothie
Copy link
Collaborator

I think this is different #1294 since this is with the GitHub api. Would either of you be interested in submitting a PR? should be easy to cap the length of the posted comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants