add new combineReleases option to create one singular Github release

[bdbch]

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 createGithubReleases option, 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 combineReleases which 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

• Added a new combineReleases option in the README.md to 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.
• Implemented the createCombinedRelease function in src/run.ts to generate a single release for all packages with the same version, including changelog aggregation and handling mixed stable/prerelease versions.
• Updated the runPublish function in src/run.ts to support the combineReleases option, 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

• Updated type definitions in src/run.ts to ensure proper typing for packages and tool variables.
• Improved inline documentation in src/run.ts to clarify the purpose and behavior of the createCombinedRelease function.

Related issues

• fixes Add a option to create multiple releases in one combined Github release #505

[changeset-bot]

🦋 Changeset detected

Latest commit: 764a047

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@changesets/action	Minor

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