feat: sdk changelog (#1495)

Add new changelogs

Author: kanwardeep007

go.mod

@@ -36,13 +36,13 @@ require (
 	github.com/sethvargo/go-githubactions v1.1.0
 	github.com/speakeasy-api/huh v1.1.2
 	github.com/speakeasy-api/openapi v0.2.4
-	github.com/speakeasy-api/openapi-generation/v2 v2.673.1
+	github.com/speakeasy-api/openapi-generation/v2 v2.673.2
 	github.com/speakeasy-api/openapi-overlay v0.10.3
-	github.com/speakeasy-api/sdk-gen-config v1.31.2
+	github.com/speakeasy-api/sdk-gen-config v1.31.3
 	github.com/speakeasy-api/speakeasy-client-sdk-go/v3 v3.26.7
 	github.com/speakeasy-api/speakeasy-core v0.20.4
 	github.com/speakeasy-api/speakeasy-proxy v0.0.2
-	github.com/speakeasy-api/versioning-reports v0.6.0
+	github.com/speakeasy-api/versioning-reports v0.6.1
 	github.com/spf13/cobra v1.9.1
 	github.com/spf13/pflag v1.0.6
 	github.com/spf13/viper v1.19.0

go.sum

@@ -228,6 +228,12 @@ github.com/gin-contrib/sse v0.1.0 h1:Y/yl/+YNO8GZSjAhjMsSuLt29uWRFHdHYUb5lYOV9qE
 github.com/gin-contrib/sse v0.1.0/go.mod h1:RHrZQHXnP2xjPF+u1gW/2HnVO7nvIa9PG3Gm+fLHvGI=
 github.com/gin-gonic/gin v1.9.1 h1:4idEAncQnU5cB7BeOkPtxjfCSye0AAm1R0RVIqJ+Jmg=
 github.com/gin-gonic/gin v1.9.1/go.mod h1:hPrL7YrpYKXt5YId3A/Tnip5kqbEAP+KLuI3SUcPTeU=
+github.com/gkampitakis/ciinfo v0.3.2 h1:JcuOPk8ZU7nZQjdUhctuhQofk7BGHuIy0c9Ez8BNhXs=
+github.com/gkampitakis/ciinfo v0.3.2/go.mod h1:1NIwaOcFChN4fa/B0hEBdAb6npDlFL8Bwx4dfRLRqAo=
+github.com/gkampitakis/go-diff v1.3.2 h1:Qyn0J9XJSDTgnsgHRdz9Zp24RaJeKMUHg2+PDZZdC4M=
+github.com/gkampitakis/go-diff v1.3.2/go.mod h1:LLgOrpqleQe26cte8s36HTWcTmMEur6OPYerdAAS9tk=
+github.com/gkampitakis/go-snaps v0.5.13 h1:Hhjmvv1WboSCxkR9iU2mj5PQ8tsz/y8ECGrIbjjPF8Q=
+github.com/gkampitakis/go-snaps v0.5.13/go.mod h1:HNpx/9GoKisdhw9AFOBT1N7DBs9DiHo/hGheFGBZ+mc=
 github.com/gliderlabs/ssh v0.3.7 h1:iV3Bqi942d9huXnzEF2Mt+CY9gLu8DNM4Obd+8bODRE=
 github.com/gliderlabs/ssh v0.3.7/go.mod h1:zpHEXBstFnQYtGnB8k8kQLol82umzn/2/snG7alWVD8=
 github.com/go-chi/chi/v5 v5.0.7 h1:rDTPXLDHGATaeHvVlLcR4Qe0zftYethFucbjVQ1PxU8=
@@ -266,6 +272,8 @@ github.com/go-test/deep v1.0.8 h1:TDsG77qcSprGbC6vTN8OuXp5g+J+b5Pcguhf7Zt61VM=
 github.com/go-test/deep v1.0.8/go.mod h1:5C2ZWiW0ErCdrYzpqxLbTX7MG14M9iiw8DgHncVwcsE=
 github.com/goccy/go-json v0.10.2 h1:CrxCmQqYDkv1z7lO7Wbh2HN93uovUHgrECaO5ZrCXAU=
 github.com/goccy/go-json v0.10.2/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I=
+github.com/goccy/go-yaml v1.18.0 h1:8W7wMFS12Pcas7KU+VVkaiCng+kG8QiFeFwzFb+rwuw=
+github.com/goccy/go-yaml v1.18.0/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
 github.com/gofrs/flock v0.12.1 h1:MTLVXXHf8ekldpJk3AKicLij9MdwOWkZ+a/jHHZby9E=
 github.com/gofrs/flock v0.12.1/go.mod h1:9zxTsyu5xtJ9DK+1tFZyibEV7y3uwDxPPfbxeeHCoD0=
 github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q=
@@ -402,6 +410,8 @@ github.com/magiconair/properties v1.8.9 h1:nWcCbLq1N2v/cpNsy5WvQ37Fb+YElfq20WJ/a
 github.com/magiconair/properties v1.8.9/go.mod h1:Dhd985XPs7jluiymwWYZ0G4Z61jb3vdS329zhj2hYo0=
 github.com/mailru/easyjson v0.9.0 h1:PrnmzHw7262yW8sTBwxi1PdJA3Iw/EKBa8psRf7d9a4=
 github.com/mailru/easyjson v0.9.0/go.mod h1:1+xMtQp2MRNVL/V1bOzuP3aP8VNwRW55fQUto+XFtTU=
+github.com/maruel/natural v1.1.1 h1:Hja7XhhmvEFhcByqDoHz9QZbkWey+COd9xWfCfn1ioo=
+github.com/maruel/natural v1.1.1/go.mod h1:v+Rfd79xlw1AgVBjbO0BEQmptqb5HvL/k9GRHB7ZKEg=
 github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=
 github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
 github.com/mattn/go-colorable v0.1.11/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
@@ -591,12 +601,12 @@ github.com/speakeasy-api/libopenapi v0.21.9-fixhiddencomps-fixed h1:PL/kpBY5vkBm
 github.com/speakeasy-api/libopenapi v0.21.9-fixhiddencomps-fixed/go.mod h1:Gc8oQkjr2InxwumK0zOBtKN9gIlv9L2VmSVIUk2YxcU=
 github.com/speakeasy-api/openapi v0.2.4 h1:XfIiVafDfq2Q3YtpjJPxjXBG9qUdXc/fKjEu4E5TyZQ=
 github.com/speakeasy-api/openapi v0.2.4/go.mod h1:vqBYh4eIgL9mVqrtdbuttji0ggR3/4xqU1ief4rjzY4=
-github.com/speakeasy-api/openapi-generation/v2 v2.673.1 h1:xMrm1BqP4rYjBK3khyJ9z7B0hLUvtJ0QLAgLz0ZjB2I=
-github.com/speakeasy-api/openapi-generation/v2 v2.673.1/go.mod h1:OWCJvRiASJRaTJFhWG6QfO1qGpjiO1KVmNVqcL3Oc+o=
+github.com/speakeasy-api/openapi-generation/v2 v2.673.2 h1:vyNe7czUBjYePtnnfpnvwSGE4oYFUrwdcaaQfCkDXk8=
+github.com/speakeasy-api/openapi-generation/v2 v2.673.2/go.mod h1:eO9cNLEsEpwH3l34GSGMijJvVUn92eeFh2SPJ6iNzgw=
 github.com/speakeasy-api/openapi-overlay v0.10.3 h1:70een4vwHyslIp796vM+ox6VISClhtXsCjrQNhxwvWs=
 github.com/speakeasy-api/openapi-overlay v0.10.3/go.mod h1:RJjV0jbUHqXLS0/Mxv5XE7LAnJHqHw+01RDdpoGqiyY=
-github.com/speakeasy-api/sdk-gen-config v1.31.2 h1:5xquHCkMr/IVt/EUfU0wsu8pj5EFFm3Q7/398kZOCWI=
-github.com/speakeasy-api/sdk-gen-config v1.31.2/go.mod h1:e9PjnCRHGa4K4EFKVU+kKmihOZjJ2V4utcU+274+bnQ=
+github.com/speakeasy-api/sdk-gen-config v1.31.3 h1:RDFVcOMzb9rysPhXLFOGEKlX70cjQzRnlyXP5NnL/iY=
+github.com/speakeasy-api/sdk-gen-config v1.31.3/go.mod h1:e9PjnCRHGa4K4EFKVU+kKmihOZjJ2V4utcU+274+bnQ=
 github.com/speakeasy-api/speakeasy-client-sdk-go/v3 v3.26.7 h1:SoWZkRlpFlv8qibCfXWrBZay1JeLS9uqJ+1cu+DFgXo=
 github.com/speakeasy-api/speakeasy-client-sdk-go/v3 v3.26.7/go.mod h1:k9JD6Rj0+Iizc5COoLZHyRIOGGITpKZ2qBuFFO8SqNI=
 github.com/speakeasy-api/speakeasy-core v0.20.4 h1:NItl2OHCHMdZcyhYGfOEZkvTxLYxnlJUAPGSoFBzMIw=
@@ -607,8 +617,8 @@ github.com/speakeasy-api/speakeasy-proxy v0.0.2 h1:u4rQ8lXvuYRCSxiLQGb5JxkZRwNID
 github.com/speakeasy-api/speakeasy-proxy v0.0.2/go.mod h1:cvMxdIEPYAvXS5mpYMU6CuJRPQnhq4gRXKE7xeCP/V0=
 github.com/speakeasy-api/speakeasy-schemas v1.3.0 h1:7Arm2d0/K9owEBQPmNon1KPERmf58g0Eg/NmPgXaEY0=
 github.com/speakeasy-api/speakeasy-schemas v1.3.0/go.mod h1:g6NfrOjYLCJZp81ZLY2ksF7afC9BW9bL4Bg1V1oAFlw=
-github.com/speakeasy-api/versioning-reports v0.6.0 h1:oLokEQ7xnDXqWAQk60Sk+ifwYaRbq3BrLX2KyT8gWxE=
-github.com/speakeasy-api/versioning-reports v0.6.0/go.mod h1:LW5FABrvi5SBbeiD3HJYw0JZYe6Rw2Xna59pFJ2BmLI=
+github.com/speakeasy-api/versioning-reports v0.6.1 h1:pvuvA1IFO7PVlpdFh7J2Y3hENDzhISFdNy0NVg/Cxb4=
+github.com/speakeasy-api/versioning-reports v0.6.1/go.mod h1:LW5FABrvi5SBbeiD3HJYw0JZYe6Rw2Xna59pFJ2BmLI=
 github.com/spewerspew/spew v0.0.0-20230513223542-89b69fbbe2bd h1:csraKifkLpqDClUIbFTetjtraueL1KUhKBm6okL+ug4=
 github.com/spewerspew/spew v0.0.0-20230513223542-89b69fbbe2bd/go.mod h1:cyGycBxnlCATLUv5jtPwaHnkiYomNWzXQougLmaCTzU=
 github.com/spf13/afero v1.11.0 h1:WJQKhtpdm3v2IzqG8VMqrr6Rf3UYpEF239Jy9wNepM8=
@@ -647,6 +657,14 @@ github.com/testcontainers/testcontainers-go v0.34.0 h1:5fbgF0vIN5u+nD3IWabQwRybu
 github.com/testcontainers/testcontainers-go v0.34.0/go.mod h1:6P/kMkQe8yqPHfPWNulFGdFHTD8HB2vLq/231xY2iPQ=
 github.com/tetratelabs/wazero v1.8.2 h1:yIgLR/b2bN31bjxwXHD8a3d+BogigR952csSDdLYEv4=
 github.com/tetratelabs/wazero v1.8.2/go.mod h1:yAI0XTsMBhREkM/YDAK/zNou3GoiAce1P6+rp/wQhjs=
+github.com/tidwall/gjson v1.18.0 h1:FIDeeyB800efLX89e5a8Y0BNH+LOngJyGrIWxG2FKQY=
+github.com/tidwall/gjson v1.18.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
+github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA=
+github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM=
+github.com/tidwall/pretty v1.2.1 h1:qjsOFOWWQl+N3RsoF5/ssm1pHmJJwhjlSbZ51I6wMl4=
+github.com/tidwall/pretty v1.2.1/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
+github.com/tidwall/sjson v1.2.5 h1:kLy8mja+1c9jlljvWTlSazM7cKDRfJuR/bOJhcY5NcY=
+github.com/tidwall/sjson v1.2.5/go.mod h1:Fvgq9kS/6ociJEDnK0Fk1cpYF4FIW6ZF7LAe+6jwd28=
 github.com/tinylib/msgp v1.1.6 h1:i+SbKraHhnrf9M5MYmvQhFnbLhAXSDWF8WWsuyRdocw=
 github.com/tinylib/msgp v1.1.6/go.mod h1:75BAfg2hauQhs3qedfdDZmWAPcFMAvJE5b9rGOMufyw=
 github.com/tklauser/go-sysconf v0.3.12 h1:0QaGUFOdQaIVdPgfITYzaTegZvdCjmYO52cSFAEVmqU=

internal/github/github.go

@@ -130,9 +130,9 @@ func GenerateChangesSummary(ctx context.Context, url string, summary changes.Sum
 	}
 	prMD := ""
 	if len(summary.Text) > 0 {
-		prMD = "## OpenAPI Change Summary\n" + summary.Text + "\n"
+		prMD = "<details>\n<summary>## OpenAPI Change Summary</summary>\n" + summary.Text + "\n" + "</details>"
 	} else {
-		prMD = "## OpenAPI Change Summary\nNo specification changes\n"
+		prMD = "<details open>\n<summary>## OpenAPI Change Summary</summary>\nNo specification changes\n" + "</details>"
 	}
 
 	// New form -- the above form is deprecated.

internal/run/source.go

@@ -58,7 +58,9 @@ type SourceResult struct {
 	MergeResult   MergeResult
 	CLIVersion    string
 	// The path to the output OAS spec
-	OutputPath string
+	OutputPath  string
+	oldSpecPath string
+	newSpecPath string
 }
 
 type LintingError struct {
@@ -194,11 +196,14 @@ func (w *Workflow) RunSource(ctx context.Context, parentStep *workflowTracking.W
 	// If the source has a previous tracked revision, compute changes against it
 	if w.lockfileOld != nil && !w.SkipChangeReport {
 		if targetLockOld, ok := w.lockfileOld.Targets[targetID]; ok && !utils.IsZeroTelemetryOrganization(ctx) {
-			sourceRes.ChangeReport, err = w.computeChanges(ctx, rootStep, targetLockOld, currentDocument)
+			changesComputed, err := w.computeChanges(ctx, rootStep, targetLockOld, currentDocument)
 			if err != nil {
 				// Don't fail the whole workflow if this fails
 				logger.Warnf("failed to compute OpenAPI changes: %s", err.Error())
 			}
+			sourceRes.ChangeReport = changesComputed.report
+			sourceRes.newSpecPath = currentDocument
+			sourceRes.oldSpecPath = changesComputed.oldSpecPath
 		}
 	}
 

internal/run/sourceTracking.go

@@ -29,6 +29,12 @@ import (
 	"github.com/speakeasy-api/speakeasy/registry"
 )
 
+type changesComputed struct {
+	report      *reports.ReportResult
+	oldSpecPath string
+	newSpecPath string
+}
+
 // embedSourceConfig implements bundler.EmbedSourceConfig interface
 type embedSourceConfig struct {
 	originalSource  *workflow.Source
@@ -72,11 +78,16 @@ func createLocalizedSource(originalSource workflow.Source, sourceResult *SourceR
 	return &localizedSource
 }
 
-func (w *Workflow) computeChanges(ctx context.Context, rootStep *workflowTracking.WorkflowStep, targetLock workflow.TargetLock, newDocPath string) (r *reports.ReportResult, err error) {
+func (w *Workflow) computeChanges(ctx context.Context, rootStep *workflowTracking.WorkflowStep, targetLock workflow.TargetLock, newDocPath string) (changesComputed, error) {
 	changesStep := rootStep.NewSubstep("Computing Document Changes")
+	var err error = nil
+	var r *reports.ReportResult = nil
+	var computedChanges changesComputed = changesComputed{
+		report: r,
+	}
 	if !registry.IsRegistryEnabled(ctx) {
 		changesStep.Skip("API Registry not enabled")
-		return
+		return computedChanges, err
 	}
 
 	defer func() {
@@ -99,36 +110,39 @@ func (w *Workflow) computeChanges(ctx context.Context, rootStep *workflowTrackin
 	} else {
 		changesStep.Skip("no previous revision found")
 
-		return
+		return computedChanges, err
 	}
 
 	changesStep.NewSubstep("Downloading prior revision")
 
 	d := workflow.Document{Location: workflow.LocationString(oldRegistryLocation)}
 	oldDocPath, err := registry.ResolveSpeakeasyRegistryBundle(ctx, d, workflow.GetTempDir())
 	if err != nil {
-		return
+		return computedChanges, err
 	}
 
+	computedChanges.oldSpecPath = oldDocPath.LocalFilePath
+
 	changesStep.NewSubstep("Computing changes")
 
 	c, err := changes.GetChanges(ctx, oldDocPath.LocalFilePath, newDocPath)
+
 	if err != nil {
-		return r, fmt.Errorf("error computing changes: %w", err)
+		return computedChanges, fmt.Errorf("error computing changes: %w", err)
 	}
 
 	changesStep.NewSubstep("Uploading changes report")
 	report, err := reports.UploadReport(ctx, c.GetHTMLReport(), shared.TypeChanges)
 	if err != nil {
-		return r, fmt.Errorf("failed to persist report: %w", err)
+		return computedChanges, fmt.Errorf("failed to persist report: %w", err)
 	}
-	r = &report
+	computedChanges.report = &report
 
-	log.From(ctx).Info(r.Message)
+	log.From(ctx).Info(computedChanges.report.Message)
 
 	summary, err := c.GetSummary()
 	if err != nil || summary == nil {
-		return r, fmt.Errorf("failed to get report summary: %w", err)
+		return computedChanges, fmt.Errorf("failed to get report summary: %w", err)
 	}
 
 	// Do not write github action changes if we have already processed this source
@@ -140,7 +154,7 @@ func (w *Workflow) computeChanges(ctx context.Context, rootStep *workflowTrackin
 	w.computedChanges[targetLock.Source] = true
 
 	changesStep.SucceedWorkflow()
-	return
+	return computedChanges, err
 }
 
 func (w *Workflow) snapshotSource(ctx context.Context, parentStep *workflowTracking.WorkflowStep, sourceID string, source workflow.Source, sourceResult *SourceResult) (err error) {

internal/run/target.go

@@ -3,6 +3,7 @@ package run
 import (
 	"context"
 	"fmt"
+	"os"
 	"path/filepath"
 	"strings"
 
@@ -21,6 +22,7 @@ import (
 	"github.com/speakeasy-api/speakeasy/internal/git"
 	"github.com/speakeasy-api/speakeasy/internal/links"
 	"github.com/speakeasy-api/speakeasy/internal/log"
+	"github.com/speakeasy-api/speakeasy/internal/sdkchangelog"
 	"github.com/speakeasy-api/speakeasy/internal/sdkgen"
 	"github.com/speakeasy-api/speakeasy/internal/utils"
 	"github.com/speakeasy-api/speakeasy/internal/validation"
@@ -171,6 +173,25 @@ func (w *Workflow) runTarget(ctx context.Context, target string) (*SourceResult,
 		}()
 	}
 
+	changelogContent := ""
+	if os.Getenv("SDK_CHANGELOG_JULY_2025") == "true" {
+		// Old & new spec and other details are updated in RunSource method
+		log.From(ctx).Infof("Calculating changelog for SDK %s SDK", utils.CapitalizeFirst(t.Target))
+		changelogContent, err = sdkchangelog.ComputeAndStoreSDKChangelog(ctx, sdkchangelog.Requirements{
+			OldSpecPath: w.SourceResults[t.Source].oldSpecPath,
+			NewSpecPath: w.SourceResults[t.Source].newSpecPath,
+			OutDir:      outDir,
+			Lang:        t.Target,
+			Verbose:     w.Verbose,
+			Target:      target,
+		})
+		if err != nil {
+			// Dont error out so that we don't block generation
+			log.From(ctx).Warnf("Error computing SDK changelog: %s", err.Error())
+		}
+		log.From(ctx).Infof("Calculating changelog for SDK %s SDK succeeded", utils.CapitalizeFirst(t.Target))
+	}
+
 	genStep := rootStep.NewSubstep(fmt.Sprintf("Generating %s SDK", utils.CapitalizeFirst(t.Target)))
 	go genStep.ListenForSubsteps(logListener)
 
@@ -198,6 +219,7 @@ func (w *Workflow) runTarget(ctx context.Context, target string) (*SourceResult,
 			SkipVersioning:        w.SkipVersioning,
 			CancellableGeneration: w.CancellableGeneration,
 			StreamableGeneration:  w.StreamableGeneration,
+			ReleaseNotes:          changelogContent,
 		},
 	)
 	if err != nil {

internal/sdkchangelog/sdkChangelog.go

@@ -0,0 +1,95 @@
+package sdkchangelog
+
+import (
+	"context"
+	"fmt"
+
+	changes "github.com/speakeasy-api/openapi-generation/v2/pkg/changes"
+	"github.com/speakeasy-api/speakeasy/internal/log"
+	"github.com/speakeasy-api/versioning-reports/versioning"
+)
+
+type Requirements struct {
+	OldSpecPath string
+	NewSpecPath string
+	OutDir      string
+	Lang        string
+	Verbose     bool
+	Target      string
+}
+
+func ComputeAndStoreSDKChangelog(ctx context.Context, changelogRequirements Requirements) (string, error) {
+	// Check if we have valid spec paths before proceeding
+	if changelogRequirements.OldSpecPath == "" || changelogRequirements.NewSpecPath == "" {
+		// If we don't have valid spec paths, skip changelog generation
+		log.From(ctx).Infof("Skipping SDK changelog generation - missing spec paths (old: %s, new: %s)",
+			changelogRequirements.OldSpecPath, changelogRequirements.NewSpecPath)
+		return "", nil
+	}
+
+	oldConfig, newConfig := changes.CreateConfigsFromSpecPaths(changes.SpecComparison{
+		OldSpecPath: changelogRequirements.OldSpecPath,
+		NewSpecPath: changelogRequirements.NewSpecPath,
+		OutputDir:   changelogRequirements.OutDir,
+		Lang:        changelogRequirements.Lang,
+		Verbose:     changelogRequirements.Verbose,
+		Logger:      log.From(ctx),
+	})
+
+	diff := changes.Changes(oldConfig, newConfig)
+	changelogContent, err := storeSDKChangelogForPullRequestDescription(ctx, changelogRequirements.Target, diff)
+	if err != nil {
+		// Swallow error so that we dont block generation
+		log.From(ctx).Warnf("Error generating new changelog: %s", err.Error())
+		return "", err
+	}
+	return changelogContent, nil
+}
+
+// target refers to workflow target name
+// The version reports written here are read in sdk-generation-action to generate commit message
+// and PR description. PR description comes from PRReport and Commit message comes from CommitReport
+func storeSDKChangelogForPullRequestDescription(ctx context.Context, target string, diff changes.SDKDiff) (string, error) {
+	// Add Release message
+	changelogContent := changes.ToMarkdown(diff)
+	err := storeKeyValueForPullRequestDescription(ctx, fmt.Sprintf("SDK_CHANGELOG_%s", target), changelogContent, "pr_report")
+	if err != nil {
+		log.From(ctx).Warnf("error computing changes: %s", err.Error())
+		return "", err
+	}
+
+	// Add Commit message
+	err = storeKeyValueForPullRequestDescription(ctx, fmt.Sprintf("COMMIT_MESSAGE_%s", target), changelogContent, "commit_report")
+	if err != nil {
+		log.From(ctx).Warnf("error computing changes: %s", err.Error())
+		return "", err
+	}
+	return changelogContent, nil
+}
+
+// A bit of a hack for being able to set and get arbitrary keys in a temp file for populating PR description
+// Using version-report machinery
+func storeKeyValueForPullRequestDescription(ctx context.Context, key string, report string, reportType string) error {
+	if reportType != "pr_report" && reportType != "commit_report" {
+		return fmt.Errorf("unknown report type passed -> %s", reportType)
+	}
+	versionReport := versioning.VersionReport{
+		Key: key,
+		// Lowest priority
+		Priority:     1,
+		MustGenerate: false,
+		BumpType:     versioning.BumpNone,
+		NewVersion:   "",
+	}
+	if reportType == "pr_report" {
+		versionReport.PRReport += report
+	} else if reportType == "commit_report" {
+		versionReport.CommitReport += report
+	}
+	err := versioning.AddVersionReport(ctx, versionReport)
+	if err != nil {
+		log.From(ctx).Warnf("failed to add version report. key: %s, report: %s, error: %s", key, report, err)
+		return err
+	}
+	return nil
+}

internal/sdkgen/sdkgen.go

@@ -70,6 +70,7 @@ type GenerateOptions struct {
 
 	CancellableGeneration *CancellableGeneration
 	StreamableGeneration  *StreamableGeneration
+	ReleaseNotes          string
 }
 
 func Generate(ctx context.Context, opts GenerateOptions) (*GenerationAccess, error) {
@@ -145,6 +146,7 @@ func Generate(ctx context.Context, opts GenerateOptions) (*GenerationAccess, err
 		generate.WithRepoDetails(opts.Repo, opts.RepoSubDir),
 		generate.WithCLIVersion(opts.CLIVersion),
 		generate.WithForceGeneration(),
+		generate.WithChangelogReleaseNotes(opts.ReleaseNotes),
 	}
 
 	if opts.Verbose {