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

Remove duplicated and older dependency bumps on generation #519

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

inFocus7
Copy link
Contributor

Changes

Added code to only generate the latest dependency bumps on release.

When following semantic versioning v[MAJOR][.MINOR][.PATCH], we only get the latest bump in the list of dependency bumps. When not following semantic versioning, we display all bumps done within the release.

Context

We've previously had instance on release, where we see multiple dependency bumps for the same dependency, for example:

** DEPENDENCY BUMPS **
- solo-io/gloo has been upgraded to v1.15.0-beta7
- solo-io/gloo has been upgraded to v1.15.0-beta8
- solo-io/gloo has been upgraded to v1.15.0-beta9

In order to mitigate this, developers have to manually remove older reference bumps within the same release version - which is easy to forget.

Other possible path(s) forward

TODO / NOTES

  • What about when dependencies get downgraded for whatever reason?
    • Ex.: Code merges Monday and bumps gloo to 1.15.0. On Tuesday we decide we want to downgrade to 1.14.0-rc5.
    • Currently, we will only show the bump to 1.15.0 on the release changelog, since it's the greater of both. BUT the downgrade was the latest and most important...
  • How can we handle the case where we have a patch postfix on a tag, and then bump to rc?
    • semver.Compare just compares the postfixes as strings, so patch is a "newer" release than an rc.

These are probably not super likely scenarios, but still technically possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant