Skip to content

Commit 9dabb92

Browse files
committed
chore: add versioning tips
1 parent e4f5e35 commit 9dabb92

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

internal/prdescription/prdescription.go

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,15 @@ func buildBody(input Input) string {
113113
versionMsg += fmt.Sprintf("\n\nThis PR will stay on the current version until the %s label is removed and/or modified.", bumpType)
114114
} else {
115115
versionMsg += "\U0001F916 (automated)" // 🤖
116+
versionMsg += "\n\n> [!TIP]"
117+
switch *labelBumpType {
118+
case versioning.BumpPrerelease:
119+
versionMsg += "\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`."
120+
case versioning.BumpPatch, versioning.BumpMinor:
121+
versionMsg += "\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)."
122+
}
123+
124+
versionMsg += "\n> Speakeasy supports manual control of SDK versioning through [multiple methods](https://www.speakeasy.com/docs/sdks/manage/versioning#manual-version-bumps)."
116125
}
117126
body.WriteString(versionMsg + "\n")
118127
}

0 commit comments

Comments
 (0)