aws-sdk-js-v3 icon indicating copy to clipboard operation
aws-sdk-js-v3 copied to clipboard

Publish more meaningful messages in changelogs (currently lerna)

Open mbrevda opened this issue 1 year ago • 5 comments

Describe the feature

Don't publish version only updates

Use Case

When using dependency automation tools such as renovebot or dependabot, version only updates significantly increase the noise to signal ratio of package updates. This causes an extra burden for packaging maintainers, increases CI compute-related expenses, and can lead to malicious package fatigue.

Proposed Solution

Infra is apparently in place to determain which packages have changed. This can be further leveraged to opt out of publishing the unchanged packages.

Other Information

see also: https://github.com/aws/aws-sdk-js-v3/discussions/4562

Acknowledgements

  • [ ] I may be able to implement this feature request
  • [ ] This feature might incur a breaking change

SDK version used

latest

Environment details (OS name and version, etc.)

n/a

mbrevda avatar Jan 08 '25 09:01 mbrevda

What is an example of a version only AWS SDK JS update?

kuhe avatar Jan 08 '25 16:01 kuhe

These: Screenshot 2025-01-08 at 6 48 31 PM

mbrevda avatar Jan 08 '25 16:01 mbrevda

These versions don't contain changes directly related to these packages, but contain updates from the SDK core such that there are detailed, sometimes minor functionality differences between the versions.

The messages could perhaps say that instead of "version bump", but these releases will not be omitted.

kuhe avatar Jan 08 '25 21:01 kuhe

these releases will not be omitted.

Seems that are actually changes, so it would not make sense to omit them.

sometimes minor functionality differences between the versions

In that case, perhaps it would make more sense to include the changes in core (or at least a link to them) or some other summary of what changes are causing the new version. This would be helpful when deciding whether to update a package.

mbrevda avatar Jan 09 '25 08:01 mbrevda

This wording is currently chosen by lerna, the monorepo manager. We don't currently have plans to migrate the monorepo system away from lerna, but moving to something like https://github.com/changesets/changesets may improve changelog creation.

Better changelog example from changesets: https://github.com/smithy-lang/smithy-typescript/blob/main/packages/is-array-buffer/CHANGELOG.md

kuhe avatar Jan 09 '25 15:01 kuhe