Skip to content

Conversation

@kanwardeep007
Copy link
Contributor

@kanwardeep007 kanwardeep007 commented Jun 18, 2025

Caution

Dont use local packages in go.mod
Revert commit 184fc89

These changes enable the sdk action to use the new SDK changelog in the following places

  • Release notes for each github release
  • PR description when speakeasy updates sdks
  • As commits messages create by speakeasy

This feature is currently behind a environment variable ENABLE_SDK_CHANGELOG

  • setting this to true enabled the new changelog

Approach

We can take one of 2 types of release/pr/commit message. We decide on the basis of environment flag SDK_CHANGELOG_JULY_2025.
DO NOTE: for terraform we do not use the new format

Currently this SDK changelog is automatically enabled for all repos which have the word speakeasy in the URL. This is to check and tweak the changelog in for the repos at the following URLs

Impact analysis for different permutations of cli and sdk-action

CLI sdk-action commit message pr message release notes
CLI sdk-action commit message pr message release notes
old cli old action works works works
old cli new action commitmessage - commitreport would be empty because its not written by old cli. So mergedVersionReport.GetCommit MarkdownSection() will be empty PR details would remain unchanged bec cli is old release notes would be unchanged because we dont write release notes in older gen.lock files. So sdk-action wont find anything there
new cli old action (in the action we try and download the latest cli so this row is more likely than row 2) remain same We add new version reports only when env is set. And because env var wont be set for all of our clients the pr message will remain the same remain same
new cli new action should work should work should work

Related PRs

Notes on the PR

  • Github is showing large diffs in internal/git/git.go but it would be easier to see the old file and the new file side by side without the diffs.

The changes in internal/git/git.go are as follows

  • refactored code into methods
  • Introduced a new method to generate new pr description (hid it behind an environment variable )

@kanwardeep007 kanwardeep007 changed the title changes to test changelog in sdk-action Feat: Changes to generate sdk changelog in releases.md and pr description Jun 25, 2025
@kanwardeep007 kanwardeep007 merged commit ab8ab3b into main Aug 11, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants