Skip to content

[fix] Add release notes summary to a file when it is too big #65

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.

Sign up for GitHub

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

Merged
tdcmeehan merged 1 commit into from
Mar 31, 2026
Merged

[fix] Add release notes summary to a file when it is too big #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,11 @@ jobs:
git checkout ${{ env.RELEASE_VERSION }}
git log --pretty="format:%ce: %s" -4
cat ~/.m2/settings.xml
mvn deploy -Pdeploy-to-ossrh -DautoReleaseAfterClose=true
if [ "${{ vars.MOCK_PUBLISHING }}" = "true" ]; then
mvn deploy -Pdeploy-to-ossrh -DautoReleaseAfterClose=true || echo "Deploy failed but continuing due to MOCK_PUBLISHING=true"
else
mvn deploy -Pdeploy-to-ossrh -DautoReleaseAfterClose=true
fi
env:
NEXUS_USERNAME: "${{ secrets.NEXUS_USERNAME }}"
NEXUS_PASSWORD: "${{ secrets.NEXUS_PASSWORD }}"
Expand Down
44 changes: 41 additions & 3 deletions ...lease-tools/src/main/java/com/facebook/presto/release/tasks/GenerateReleaseNotesTask.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,38 @@ public void run()

log.info("Generating release notes pull request");
String releaseNotesBranch = "release-notes-" + version.getVersion();
createReleaseNotesCommit(version.getVersion(), releaseNotesBranch, releaseNotes);

// Create full summary with footer
String fullSummary = releaseNotesSummary + RELEASE_NOTES_FOOTER;

// Check if body exceeds GitHub's limit and handle accordingly
String prBody;
boolean summaryFileCreated = false;
final int githubPrBodyLimit = 65000; // Use 65000 to leave some buffer

if (fullSummary.length() > githubPrBodyLimit) {
log.info("PR body exceeds GitHub limit (%d chars), creating summary file", fullSummary.length());
summaryFileCreated = true;

// Create truncated version with reference to full file
String truncationMessage = format(
"\n\n\n**Note:** The full release notes summary was too large (%d characters) for GitHub's PR body limit.\n" +
"The complete summary has been saved to [`release-notes-missing-%s.md`](../blob/release-notes-%s/release-notes-missing-%s.md) in this pull request.\n" +
"**Please delete this file before merging.**\n",
fullSummary.length(),
Comment thread
sourcery-ai[bot] marked this conversation as resolved.
version.getVersion(),
version.getVersion(),
version.getVersion());

int availableSpace = Math.max(0, githubPrBodyLimit - truncationMessage.length() - RELEASE_NOTES_FOOTER.length() - 100);
String truncatedSummary = releaseNotesSummary.substring(0, Math.min(availableSpace, releaseNotesSummary.length()));
prBody = truncatedSummary + RELEASE_NOTES_FOOTER + truncationMessage;
}
else {
prBody = fullSummary;
}

createReleaseNotesCommit(version.getVersion(), releaseNotesBranch, releaseNotes, summaryFileCreated ? Optional.of(fullSummary) : Optional.empty());
git.push(ORIGIN, releaseNotesBranch, false);

String originName = repository.getOriginName();
Expand All @@ -205,7 +236,7 @@ public void run()
"master",
format("%s:%s", originRepo.split("/")[0], releaseNotesBranch),
format("docs: Add release notes for %s", version.getVersion()),
releaseNotesSummary + RELEASE_NOTES_FOOTER);
prBody);
log.info("Release notes pull request created: %s", releaseNotesPullRequest.getUrl());
}

Expand Down Expand Up @@ -419,7 +450,7 @@ private String generateCommits(List<Commit> commits)
.collect(joining("\n"));
}

private void createReleaseNotesCommit(String version, String branch, String releaseNotes)
private void createReleaseNotesCommit(String version, String branch, String releaseNotes, Optional<String> fullSummary)
{
git.checkout(Optional.empty(), Optional.of(branch));

Expand All @@ -429,6 +460,13 @@ private void createReleaseNotesCommit(String version, String branch, String rele
List<String> lines = new LinkedList<>(asCharSource(Paths.get(gitDirectory, RELEASE_NOTES_LIST_FILE).toFile(), UTF_8).readLines());
lines.add(7, format(" Release-%s [%tF] <release/release-%s>", version, new Date(), version));
asCharSink(Paths.get(gitDirectory, RELEASE_NOTES_LIST_FILE).toFile(), UTF_8).write(Joiner.on("\n").join(lines) + "\n");

// Write full summary to file if it was too large for PR body
if (fullSummary.isPresent()) {
String summaryFileName = format("release-notes-missing-%s.md", version);
asCharSink(Paths.get(gitDirectory, summaryFileName).toFile(), UTF_8).write(fullSummary.get());
log.info("Created full summary file: %s", summaryFileName);
}
}
catch (IOException e) {
throw new RuntimeException(e);
Expand Down
Loading