add new combineReleases option to create one singular Github release#504
Open
bdbch wants to merge 3 commits intochangesets:mainfrom
Open
add new combineReleases option to create one singular Github release#504bdbch wants to merge 3 commits intochangesets:mainfrom
bdbch wants to merge 3 commits intochangesets:mainfrom
Conversation
🦋 Changeset detectedLatest commit: 764a047 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
alexvcasillas
approved these changes
Jun 21, 2025
Author
|
Any updates here? |
Do we need anything else here to be reviewed @bdbch ? |
Author
|
Nope |
Author
|
Is there any way to get some feedback on the PR? |
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
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.
This feature is something I was looking for our use case over on Tiptap. We currently use fixed versioning for all our packages to make it easy for users to figure out which version is compatible with each other - however when we enable the
createGithubReleasesoption, our releases section on Github gets very crowded as we'll have tons of releases not having any meaningful content, yet is still created.I added a new option
combineReleaseswhich should when enabled only create one Github release per version found. I added warnings if for whatever reason this option is used while releasing multiple package versions as that can lead to issues with the tag name / tag creation and releasing.I'm not sure how to run this in a dry-run for testing. Maybe a maintainer can help me out with that?
AI Summary:
This pull request introduces a new feature to support combined GitHub releases for packages using fixed versioning. It also includes updates to documentation and error handling to ensure clarity and robustness when using this feature.
New Feature: Combined GitHub Releases
combineReleasesoption in theREADME.mdto allow combining all package releases into a single GitHub release when using fixed versioning. Included a warning about potential issues with overlapping tags when using different versioning strategies.createCombinedReleasefunction insrc/run.tsto generate a single release for all packages with the same version, including changelog aggregation and handling mixed stable/prerelease versions.runPublishfunction insrc/run.tsto support thecombineReleasesoption, including logic for grouping packages by version and creating combined releases for each version. Added warnings and error handling for edge cases like multiple package versions.Documentation and Code Enhancements
src/run.tsto ensure proper typing forpackagesandtoolvariables.src/run.tsto clarify the purpose and behavior of thecreateCombinedReleasefunction.Related issues