Skip to content

feat: add versioning tips in customer-facing PR description #275

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
2ynn merged 1 commit into from
Jan 29, 2026
Merged

feat: add versioning tips in customer-facing PR description #275

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
11 changes: 11 additions & 0 deletions internal/git/git.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -911,13 +911,24 @@ func (g *Git) generatePRTitleAndBody(info PRInfo, labelTypes map[string]github.L
if labelBumpType != nil && *labelBumpType != versioning.BumpCustom && *labelBumpType != versioning.BumpNone {
// be very careful if changing this it critically aligns with a regex in parseBumpFromPRBody
versionBumpMsg := "Version Bump Type: " + fmt.Sprintf("[%s]", string(*labelBumpType)) + " - "

if info.VersioningInfo.ManualBump {
versionBumpMsg += string(versionbumps.BumpMethodManual) + " (manual)"
// if manual we bold the message
versionBumpMsg = "**" + versionBumpMsg + "**"
versionBumpMsg += fmt.Sprintf("\n\nThis PR will stay on the current version until the %s label is removed and/or modified.", string(*labelBumpType))
} else {
versionBumpMsg += string(versionbumps.BumpMethodAutomated) + " (automated)"

versionBumpMsg += "\n\n> [!TIP]"
switch *labelBumpType {
case versioning.BumpPrerelease:
versionBumpMsg += "\n> To exit [pre-release versioning](https://www.speakeasy.com/docs/sdks/manage/versioning#pre-release-version-bumps), set a new version or run `speakeasy bump graduate`."
case versioning.BumpPatch, versioning.BumpMinor:
versionBumpMsg += "\n> If updates to your OpenAPI document introduce breaking changes, be sure to update the `info.version` field to [trigger the correct version bump](https://www.speakeasy.com/docs/sdks/manage/versioning#openapi-document-changes)."
}

versionBumpMsg += "\n> Speakeasy supports manual control of SDK versioning through [multiple methods](https://www.speakeasy.com/docs/sdks/manage/versioning#manual-version-bumps)."
}
body += fmt.Sprintf(`## Versioning

Expand Down
Loading