[SDK-2072] Create GHA to sync release notes with ReadMe Version History #128
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference
SDK-2072 -- Help Docs automate Readme changelogs
Summary
Created a new Github Action that runs whenever a new Github Release is made. It uses the release tag and description to create a new section in the public readme doc's version history page. It also uses this data to send a Slack message in the SDK channel announcing the new release.
Motivation
To streamline and speed up the release process even more while keeping out docs up to date.
Type Of Change
Testing Instructions
The action can be run locally using Act or a test release can be made to ensure everything works properly.
cc @BranchMetrics/saas-sdk-devs for visibility.