feat: Changes to generate sdk changelog in releases.md and pr description (#229)

Add new SDK changelog

Author: kanwardeep007

go.mod

@@ -12,9 +12,9 @@ require (
 	github.com/pb33f/libopenapi v0.15.14
 	github.com/pkg/errors v0.9.1
 	github.com/speakeasy-api/git-diff-parser v0.0.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.15.4
-	github.com/speakeasy-api/versioning-reports v0.6.0
+	github.com/speakeasy-api/versioning-reports v0.6.1
 	github.com/stretchr/testify v1.9.0
 	golang.org/x/exp v0.0.0-20240213143201-ec583247a57a
 	golang.org/x/oauth2 v0.11.0

go.sum

@@ -138,12 +138,12 @@ github.com/skeema/knownhosts v1.2.1 h1:SHWdIUa82uGZz+F+47k8SY4QhhI291cXCpopT1lK2
 github.com/skeema/knownhosts v1.2.1/go.mod h1:xYbVRSPxqBZFrdmDyMmsOs+uX1UZC3nTN3ThzgDxUwo=
 github.com/speakeasy-api/git-diff-parser v0.0.3 h1:LL12d+HMtSyj6O/hQqIn/lgDPYI6ci/DEhk0la/xA+0=
 github.com/speakeasy-api/git-diff-parser v0.0.3/go.mod h1:P46HmmVVmwA9P8h2wa0fDpmRM8/grbVQ+uKhWDtpkIY=
-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.15.4 h1:lPVNakwHrrRWRaNIdIHE6BK7RI6B/jpdwbtvI/xPEYo=
 github.com/speakeasy-api/speakeasy-client-sdk-go/v3 v3.15.4/go.mod h1:b4fiZ1Wid0JHwwiYqhaPifDwjmC15uiN7A8Cmid+9kw=
-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/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=

internal/actions/release.go

@@ -22,6 +22,10 @@ func Release() error {
 	if accessToken == "" {
 		return errors.New("github access token is required")
 	}
+	repoURL := os.Getenv("GITHUB_REPOSITORY")
+	if strings.Contains(strings.ToLower(repoURL), "speakeasy-api") || strings.Contains(strings.ToLower(repoURL), "speakeasy-sdks") || strings.Contains(strings.ToLower(repoURL), "ryan-timothy-albert") {
+		os.Setenv("SDK_CHANGELOG_JULY_2025", "true")
+	}
 
 	g, err := initAction()
 	if err != nil {
@@ -31,9 +35,11 @@ func Release() error {
 	dir := "."
 	usingReleasesMd := false
 	var providesExplicitTarget bool
+	logging.Info("specificTarget: %s", environment.SpecifiedTarget())
 	if specificTarget := environment.SpecifiedTarget(); specificTarget != "" {
 		workflow, err := configuration.GetWorkflowAndValidateLanguages(true)
 		if err != nil {
+			logging.Error("error: %v", err)
 			return err
 		}
 		if target, ok := workflow.Targets[specificTarget]; ok {
@@ -42,11 +48,12 @@ func Release() error {
 			}
 
 			dir = filepath.Join(environment.GetWorkingDirectory(), dir)
-
 			providesExplicitTarget = true
 		}
 	}
 
+	logging.Info("providesExplicitTarget is set as: %v", providesExplicitTarget)
+
 	if !providesExplicitTarget {
 		// This searches for files that would be referenced in the GH Action trigger
 		files, err := g.GetCommitedFiles()
@@ -61,23 +68,40 @@ func Release() error {
 		}
 
 		dir, usingReleasesMd = GetDirAndShouldUseReleasesMD(files, dir, usingReleasesMd)
+
 	}
 
+	var languages map[string]releases.LanguageReleaseInfo
 	var latestRelease *releases.ReleasesInfo
+	var targetSpecificReleaseNotes releases.TargetReleaseNotes = nil
+	oldReleaseContent := ""
+
+	// Old way of getting release Info (uses RELEASES.md)
 	if usingReleasesMd {
+		logging.Info("Using RELEASES.md to get release info")
 		latestRelease, err = releases.GetLastReleaseInfo(dir)
-		if err != nil {
-			return err
-		}
 	} else {
+		logging.Info("Using gen lockfile to get release info")
 		latestRelease, err = releases.GetReleaseInfoFromGenerationFiles(dir)
 		if err != nil {
+			fmt.Printf("Error getting release info from generation files: %v\n", err)
 			return err
 		}
+		// targetSpecificReleaseNotes variable is present only if SDK_CHANGELOG_JULY_2025 env is true
+		targetSpecificReleaseNotes, err = releases.GetTargetSpecificReleaseNotes(dir)
+		if err != nil {
+			fmt.Printf("Error getting target specific release notes: %v\n", err)
+		}
+
+	}
+	if err != nil {
+		return err
 	}
+	languages = latestRelease.Languages
+	oldReleaseContent = latestRelease.String()
 
 	outputs := map[string]string{}
-	for lang, info := range latestRelease.Languages {
+	for lang, info := range languages {
 		outputs[utils.OutputTargetRegenerated(lang)] = "true"
 		outputs[utils.OutputTargetDirectory(lang)] = info.Path
 	}
@@ -86,7 +110,7 @@ func Release() error {
 		return err
 	}
 
-	if err := g.CreateRelease(*latestRelease, outputs); err != nil {
+	if err := g.CreateRelease(oldReleaseContent, languages, outputs, targetSpecificReleaseNotes); err != nil {
 		return err
 	}
 
@@ -95,7 +119,7 @@ func Release() error {
 	}
 
 	if os.Getenv("SPEAKEASY_API_KEY") != "" {
-		if err = addCurrentBranchTagging(g, latestRelease.Languages); err != nil {
+		if err = addCurrentBranchTagging(g, languages); err != nil {
 			return errors.Wrap(err, "failed to tag registry images")
 		}
 	}

internal/actions/runWorkflow.go

@@ -1,6 +1,7 @@
 package actions
 
 import (
+	"encoding/json"
 	"fmt"
 	"os"
 	"strings"
@@ -9,7 +10,6 @@ import (
 	"github.com/pkg/errors"
 	"github.com/speakeasy-api/sdk-generation-action/internal/utils"
 	"github.com/speakeasy-api/sdk-generation-action/internal/versionbumps"
-	"github.com/speakeasy-api/versioning-reports/versioning"
 
 	"github.com/speakeasy-api/sdk-generation-action/internal/configuration"
 	"github.com/speakeasy-api/sdk-generation-action/internal/git"
@@ -102,6 +102,12 @@ func RunWorkflow() error {
 	anythingRegenerated := false
 
 	var releaseInfo releases.ReleasesInfo
+	runResultInfo, err := json.MarshalIndent(runRes, "", "  ")
+	if err != nil {
+		logging.Debug("failed to marshal runRes : %s\n", err)
+	} else {
+		logging.Debug("Result of running the command is: %s\n", runResultInfo)
+	}
 	if runRes.GenInfo != nil {
 		docVersion := runRes.GenInfo.OpenAPIDocVersion
 		resolvedVersion = runRes.GenInfo.SpeakeasyVersion
@@ -150,18 +156,18 @@ func RunWorkflow() error {
 		}
 
 		if err := releases.UpdateReleasesFile(releaseInfo, releasesDir); err != nil {
+			logging.Error("error while updating releases file: %v", err.Error())
 			return err
 		}
 
-		if _, err := g.CommitAndPush(docVersion, resolvedVersion, "", environment.ActionRunWorkflow, false); err != nil {
+		if _, err := g.CommitAndPush(docVersion, resolvedVersion, "", environment.ActionRunWorkflow, false, runRes.VersioningInfo.VersionReport); err != nil {
 			return err
 		}
 	}
 
 	outputs["resolved_speakeasy_version"] = resolvedVersion
-
 	if sourcesOnly {
-		if _, err := g.CommitAndPush("", resolvedVersion, "", environment.ActionRunWorkflow, sourcesOnly); err != nil {
+		if _, err := g.CommitAndPush("", resolvedVersion, "", environment.ActionRunWorkflow, sourcesOnly, nil); err != nil {
 			return err
 		}
 	}
@@ -184,6 +190,7 @@ func RunWorkflow() error {
 		OpenAPIChangeSummary: runRes.OpenAPIChangeSummary,
 		GenInfo:              runRes.GenInfo,
 		currentRelease:       &releaseInfo,
+		releaseNotes:         runRes.ReleaseNotes,
 	}); err != nil {
 		return err
 	}
@@ -207,10 +214,11 @@ type finalizeInputs struct {
 	LintingReportURL     string
 	ChangesReportURL     string
 	OpenAPIChangeSummary string
-	VersioningReport     *versioning.MergedVersionReport
 	VersioningInfo       versionbumps.VersioningInfo
 	GenInfo              *run.GenerationInfo
 	currentRelease       *releases.ReleasesInfo
+	// key is language target name, value is release notes
+	releaseNotes map[string]string
 }
 
 // Sets outputs and creates or adds releases info
@@ -233,13 +241,14 @@ func finalize(inputs finalizeInputs) error {
 		}
 	}()
 
+	logging.Info("getMode from the environment: %s\n", environment.GetMode())
+	logging.Info("SDK_CHANGELOG_JULY_2025: %s", os.Getenv("SDK_CHANGELOG_JULY_2025"))
 	switch environment.GetMode() {
 	case environment.ModePR:
 		branchName, pr, err := inputs.Git.FindExistingPR(branchName, environment.ActionFinalize, inputs.SourcesOnly)
 		if err != nil {
 			return err
 		}
-
 		pr, err = inputs.Git.CreateOrUpdatePR(git.PRInfo{
 			BranchName:           branchName,
 			ReleaseInfo:          inputs.currentRelease,
@@ -272,11 +281,25 @@ func finalize(inputs finalizeInputs) error {
 
 	case environment.ModeDirect:
 		var releaseInfo *releases.ReleasesInfo
+		var oldReleaseInfo string
+		var languages map[string]releases.LanguageReleaseInfo
+		var targetSpecificReleaseNotes releases.TargetReleaseNotes = nil
 		if !inputs.SourcesOnly {
 			releaseInfo = inputs.currentRelease
+			languages = releaseInfo.Languages
+			oldReleaseInfo = releaseInfo.String()
+			logging.Info("release Notes: %+v", inputs.releaseNotes)
+			if os.Getenv("SDK_CHANGELOG_JULY_2025") == "true" && inputs.releaseNotes != nil {
+				targetSpecificReleaseNotes = inputs.releaseNotes
+			}
+
 			// We still read from releases info for terraform generations since they use the goreleaser
+			// Read from Releases.md for terraform generations
 			if inputs.Outputs[utils.OutputTargetRegenerated("terraform")] == "true" {
 				releaseInfo, err = getReleasesInfo()
+				oldReleaseInfo = releaseInfo.String()
+				targetSpecificReleaseNotes = nil
+				languages = releaseInfo.Languages
 				if err != nil {
 					return err
 				}
@@ -289,7 +312,7 @@ func finalize(inputs finalizeInputs) error {
 		}
 
 		if !inputs.SourcesOnly {
-			if err := inputs.Git.CreateRelease(*releaseInfo, inputs.Outputs); err != nil {
+			if err := inputs.Git.CreateRelease(oldReleaseInfo, languages, inputs.Outputs, targetSpecificReleaseNotes); err != nil {
 				return err
 			}
 		}

internal/actions/suggest.go

@@ -60,7 +60,7 @@ func Suggest() error {
 
 	outputs["cli_output"] = out
 
-	if _, err := g.CommitAndPush("", "", environment.GetOpenAPIDocOutput(), environment.ActionSuggest, false); err != nil {
+	if _, err := g.CommitAndPush("", "", environment.GetOpenAPIDocOutput(), environment.ActionSuggest, false, nil); err != nil {
 		return err
 	}
 

internal/cli/cli.go

@@ -40,6 +40,17 @@ var defaultSupportedTargets = []string{
 	"typescript",
 }
 
+// Targets for the new changelog - JULY 2025
+var DefaultSupportedTargetsForChangelog = []string{
+	"typescript",
+	"python",
+	"go",
+	"java",
+	"csharp",
+	"php",
+	"ruby",
+}
+
 func GetSupportedTargetNames() []string {
 	out, err := runSpeakeasyCommand("generate", "supported-targets")
 	if err == nil && out != "" {

internal/cli/speakeasy.go

@@ -17,6 +17,7 @@ import (
 
 	"github.com/speakeasy-api/sdk-generation-action/internal/download"
 	"github.com/speakeasy-api/sdk-generation-action/internal/environment"
+	"github.com/speakeasy-api/sdk-generation-action/internal/logging"
 )
 
 type Git interface {
@@ -78,9 +79,9 @@ func Download(pinnedVersion string, g Git) (string, error) {
 func runSpeakeasyCommand(args ...string) (string, error) {
 	baseDir := environment.GetBaseDir()
 	extraRunEnvVars := environment.SpeakeasyEnvVars()
-
 	cmdPath := filepath.Join(baseDir, "bin", "speakeasy")
-
+	logging.Info("The command path being executed: %s", cmdPath)
+	logging.Info("The command args: %s", args)
 	cmd := exec.Command(cmdPath, args...)
 	cmd.Dir = filepath.Join(environment.GetWorkspace(), "repo", environment.GetWorkingDirectory())
 	cmd.Env = os.Environ()