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

feat(deps): Upgrade to Latest Minor Versions #266

Merged
merged 2 commits into from
Oct 24, 2024
Merged

Conversation

jshlbrd
Copy link
Collaborator

@jshlbrd jshlbrd commented Oct 24, 2024

Description

  • Upgrades all dependencies to their latest patch or minor version
    • gjson had a minor version update which requires a new release in Substation
  • Added new guidance for dependency versioning

Motivation and Context

If any exported packages directly expose the functionality of a dependency, then we need to version Substation similarly to that dependency. gjson went from v1.17.1 to v1.18.0, so this is PR is considered a feature to also bump Substation up to a new minor release.

How Has This Been Tested?

  • All unit tests are passing.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

@jshlbrd jshlbrd marked this pull request as ready for review October 24, 2024 14:14
@jshlbrd jshlbrd requested a review from a team as a code owner October 24, 2024 14:14
github.com/sirupsen/logrus v1.9.3
github.com/spf13/cobra v1.8.1
github.com/tidwall/gjson v1.17.1
github.com/tidwall/gjson v1.18.0 // Upgrades require SemVer bump.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand the intent that a upgrade to new features in gjson can give users new features and should be considered a features, but this specific upgrade to v1.18 seems to be a performance improvement. Since this isn't necessarily a Substation feature we might not need a version bump for this specific upgrade?

Copy link
Collaborator Author

@jshlbrd jshlbrd Oct 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the tldr on this is that we shouldn't make assumptions about why a dependency bumped their version the way that they did -- they know their code better than we do. It's low effort (and not very impactful on users) for us to bump our own version whenever these packages do.

In this case, the changes look like it should have been a patch release, but for some reason it's not and I don't think we need to put much thought into why and how it affects our own versioning. (The caveat to this is if they break a unit test with a non-breaking update, then that's different and we should be more thoughtful about upgrading.)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, regardless we have other content to bump our own patch release version. Semantically this specific upgrade is more of a chore than a feature 👍

github.com/sirupsen/logrus v1.9.3
github.com/spf13/cobra v1.8.1
github.com/tidwall/gjson v1.17.1
github.com/tidwall/gjson v1.18.0 // Upgrades require SemVer bump.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, regardless we have other content to bump our own patch release version. Semantically this specific upgrade is more of a chore than a feature 👍

@jshlbrd jshlbrd merged commit 9db10a8 into main Oct 24, 2024
7 checks passed
@jshlbrd jshlbrd deleted the jshlbrd/feat/go-deps branch October 24, 2024 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants