intuit / intuit/auto

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

Open
#2,418 3 comments 2 reactions 0 assignees View on GitHub
bug
Dominant language
TypeScript
Stars
2.5k
Forks
221
PR merge metrics
No merged PRs in 30d

Description

**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:**

```txt

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

```

**Additional context**

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.