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

Automatically update the Golang dependencies using a CRON #14891

Merged
merged 5 commits into from
Jan 5, 2024

Conversation

frouioui
Copy link
Member

@frouioui frouioui commented Jan 4, 2024

Description

This PR adds a new workflow that runs either on manual trigger or on a weekly CRON. The workflow will attempt to upgrade all the Golang dependencies to a newer version using go get -u ./... followed by go mod tidy. It will run main. This avoid having to manually upgrade the dependencies or even to forget about upgrading them.

@dbussink recently did a PR that manually does this (#14888), this new workflow will ensure this work is done consistently.

I ran some tests on my fork here where automation created the PR:

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Signed-off-by: Florent Poinsard <[email protected]>
Signed-off-by: Florent Poinsard <[email protected]>
Copy link
Contributor

vitess-bot bot commented Jan 4, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Jan 4, 2024
@github-actions github-actions bot added this to the v19.0.0 milestone Jan 4, 2024
@frouioui frouioui added Type: Feature Component: Build/CI go and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Jan 4, 2024
Signed-off-by: Florent Poinsard <[email protected]>
Signed-off-by: Florent Poinsard <[email protected]>
Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

I think that this is definitely good on/for main. For release branches, I'm not sure that we want to upgrade go deps unless necessary due to security issues/vulns and other high priority issues. Upgrading a dependency can unexpectedly change behavior — a previously deprecated thing can be removed, behavior of something changes in a impactful way, etc. In fact we ran into this recently with an azure lib upgrade: #13770

I'm not hard set against it, but it's a consideration worth discussing IMO.

pull-requests: write
strategy:
matrix:
branch: [ main, release-18.0, release-17.0, release-16.0 ]
Copy link
Contributor

Choose a reason for hiding this comment

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

This is the only part that I have some reservations/questions about.

- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: 1.21.5
Copy link
Contributor

Choose a reason for hiding this comment

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

How will we keep this aligned with the go version as we upgrade that pretty regularly, especially on main.

If we do end up doing this on release branches, will this not cause issues when those are using an older version of go than main?

Copy link
Member Author

Choose a reason for hiding this comment

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

The automation that bumps the golang version throughout the codebase will keep this aligned for us without having to do anything more.

@dbussink
Copy link
Contributor

dbussink commented Jan 5, 2024

Agree with @mattlord here that we should do this only for main and not for release branches. We should bump the latter as security and bug fixes have a need for dependency updates.

Signed-off-by: Florent Poinsard <[email protected]>
@frouioui
Copy link
Member Author

frouioui commented Jan 5, 2024

@mattlord @dbussink agreed! that makes sense to me, I have pushed 4d1d433 which reflect the changes you are suggesting.

@frouioui frouioui requested a review from mattlord January 5, 2024 15:11
Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

Automate all the things!
images

@frouioui frouioui merged commit b0f6fa2 into vitessio:main Jan 5, 2024
99 checks passed
@frouioui frouioui deleted the auto-bump-go-deps branch January 5, 2024 16:04
delete-branch: true
title: "Upgrade the Golang Dependencies"
body: |
This Pull Request updates all the Goland dependencies to their latest version using `go get -u ./...`.
Copy link
Contributor

Choose a reason for hiding this comment

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

shoot sorry i missed this

s/Goland/Golang

Copy link
Member Author

Choose a reason for hiding this comment

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

Will be fixed with #14896

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.

Automatically update Golang dependencies using GitHub Actions
4 participants