Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish more meaningful messages in changelogs (currently lerna) #6781

Open
2 tasks
mbrevda opened this issue Jan 8, 2025 · 5 comments
Open
2 tasks

Publish more meaningful messages in changelogs (currently lerna) #6781

mbrevda opened this issue Jan 8, 2025 · 5 comments
Labels
feature-request New feature or enhancement. May require GitHub community feedback. p3 This is a minor priority issue queued This issues is on the AWS team's backlog

Comments

@mbrevda
Copy link

mbrevda commented Jan 8, 2025

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: #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 mbrevda added feature-request New feature or enhancement. May require GitHub community feedback. needs-triage This issue or PR still needs to be triaged. labels Jan 8, 2025
@kuhe
Copy link
Contributor

kuhe commented Jan 8, 2025

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

@mbrevda
Copy link
Author

mbrevda commented Jan 8, 2025

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

@zshzbh zshzbh added p3 This is a minor priority issue and removed needs-triage This issue or PR still needs to be triaged. labels Jan 8, 2025
@kuhe
Copy link
Contributor

kuhe commented Jan 8, 2025

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.

@mbrevda
Copy link
Author

mbrevda commented Jan 9, 2025

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.

@kuhe kuhe changed the title Don't publish version only updates Publish more meaningful messages in changelogs (currently lerna) Jan 9, 2025
@kuhe
Copy link
Contributor

kuhe commented Jan 9, 2025

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 kuhe added the queued This issues is on the AWS team's backlog label Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request New feature or enhancement. May require GitHub community feedback. p3 This is a minor priority issue queued This issues is on the AWS team's backlog
Projects
None yet
Development

No branches or pull requests

3 participants