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.

Sign up for GitHub

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

Jump to bottom

Do not fail build on incorrect Go version #12809

Merged
merged 1 commit into from
Apr 3, 2023
Merged

Do not fail build on incorrect Go version #12809

merged 1 commit into from
Apr 3, 2023

Conversation

frouioui
Copy link
Member

@frouioui frouioui commented Apr 3, 2023 •
edited
Loading

Description

Following the recent Golang upgrade on main (#12706) we want to let developers choose whatever Golang version they want, and thus not fail the build if the version is not exactly what we expect.

There are several places where the Golang version has to be exactly how we expect it to be:

  • In the Docker images
  • In the CI workflows

With the new automated process to upgrade the Golang version in the repository we now have more trusts that the two places listed above will always contain valid values.

If the version is not what we expect, we print a warning.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

Deployment Notes

@frouioui frouioui requested a review from deepthi as a code owner April 3, 2023 08:59
@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Apr 3, 2023
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Apr 3, 2023 •
edited by GuptaManan100
Loading

Review Checklist

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

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a test is added or modified, there should be a documentation on top of the test to explain what the expected behavior is what the test does.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

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

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

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

@frouioui frouioui added Type: CI/Build Component: General Changes throughout the code base Backport to: release-14.0 go and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work Backport to: release-14.0 labels Apr 3, 2023
@frouioui
Copy link
Member Author

frouioui commented Apr 3, 2023

Not backporting this to 14 and 15 as they are using go1.18.9 which is a relatively old release of Go.

@frouioui frouioui removed the NeedsWebsiteDocsUpdate What it says label Apr 3, 2023
@github-actions github-actions bot added this to the v17.0.0 milestone Apr 3, 2023
@frouioui frouioui merged commit 27cd9c3 into vitessio:main Apr 3, 2023
@frouioui frouioui deleted the do-not-fail-incorrect-go-version branch April 3, 2023 13:02
@vitess-bot vitess-bot bot mentioned this pull request Apr 3, 2023
Merged
deepthi
deepthi reviewed Apr 5, 2023
View reviewed changes
build.env
@@ -17,7 +17,7 @@
source ./tools/shell_functions.inc

go version >/dev/null 2>&1 || fail "Go is not installed or is not in \$PATH. See https://vitess.io/contributing/build-from-source for install instructions."
goversion_min 1.20.2 || fail "Go version reported: `go version`. Version 1.20.2+ required. See https://vitess.io/contributing/build-from-source for install instructions."
goversion_min 1.20.2 || echo "Go version reported: `go version`. Version 1.20.2+ required. See https://vitess.io/contributing/build-from-source for install instructions."
Copy link
Member

Choose a reason for hiding this comment

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

required -> recommended.
Otherwise the message is misleading, it's easy to assume that the build failed because historically that is what used to happen.

Copy link
Member Author

Choose a reason for hiding this comment

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

Makes sense, i'll update this.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fix Pull Request: #12841

@frouioui frouioui mentioned this pull request Apr 5, 2023
Merged
4 tasks
deepthi pushed a commit that referenced this pull request Apr 12, 2023
@vitess-bot @frouioui
[release-16.0] Do not fail build on incorrect Go version (#12809) (#1…
b04c38d 
…2812)

* Do not fail build on incorrect Go version

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

* Remove misleading message in build.env

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

---------

Signed-off-by: Florent Poinsard <[email protected]>
Co-authored-by: Florent Poinsard <[email protected]>
frouioui added a commit to planetscale/vitess that referenced this pull request Nov 21, 2023
@planetscale-actions-bot @frouioui
CherryPick(vitessio#12809): Do not fail build on incorrect Go version (…
4b3dbb2 
…vitessio#1789)

* cherry pick of 12809

Signed-off-by: Vitess Cherry-Pick Bot <[email protected]>

* Fix conflicts

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

---------

Signed-off-by: Vitess Cherry-Pick Bot <[email protected]>
Signed-off-by: Florent Poinsard <[email protected]>
Co-authored-by: Vitess Cherry-Pick Bot <[email protected]>
Co-authored-by: Florent Poinsard <[email protected]>
@hmaurer hmaurer mentioned this pull request Mar 21, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@deepthi deepthi deepthi left review comments

@GuptaManan100 GuptaManan100 GuptaManan100 approved these changes

@systay systay systay approved these changes

@mattlord mattlord Awaiting requested review from mattlord

Assignees
No one assigned
Labels
Component: General Changes throughout the code base go Type: CI/Build
Projects
None yet
Milestone
v17.0.0
Development

Successfully merging this pull request may close these issues.
4 participants
@frouioui @deepthi @systay @GuptaManan100