Update to using Go 1.17 for project #352
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1.17 is now the preferred Go version for Arduino tooling projects.
`go mod tidy` has an inexplicable default behavior: https://go.dev/ref/mod#go-mod-tidy >By default, go mod tidy will check that the selected versions of modules do not change when the module graph is loaded > by the Go version immediately preceding the version indicated in the go directive. The `go` directive indicates the version of Go the project is written for. The `go mod tidy` command should not fail if the module is configured in a manner that is incompatible with an unsupported Go version. So it is necessary use use the `-compat=1.17` flag to cause the `go mod tidy` command to behave correctly and check for compatibility with the version of Go that is in use. Previously, I had thought that `go mod tidy` was straightforward enough that it did not make sense to wrap it in a task. This is no longer true, so it is moved to the `go:tidy` task so that the developer does not need to think about what obscure flags are required to make it behave correctly and to be aligned with the results of the "Check Go" CI workflow.
For the convenience of the developer, some "umbrella" tasks have been defined, which run all the specific tasks of a basic class: - `check`: run all automated checks for issues - `fix`: make automated corrections for issues where possible The project contains multiple Go modules in different folders: - `github.com/arduino/arduino-lint`: root folder - `github.com/arduino/arduino-lint/docsgen`: docsgen subfolder - `github.com/arduino/arduino-lint/ruledocsgen`: ruledocsgen subfolder `go` commands are applied to the module in the current working directory. The tasks are configured so that the working directory can be specified, defaulting to the root. Previously, the "umbrella" tasks only ran the `go:*` tasks with the default, meaning only the `github.com/arduino/arduino-lint` module was covered by these tasks. This is contrary to the intended purpose of these "umbrella" tasks, which is to allow the developer to run a couple of standardized commands to find or fix all problems, trading efficiency for convenience.
per1234
added
type: enhancement
Codecov Report
@@ Coverage Diff @@
## main #352 +/- ##
=======================================
Coverage 90.01% 90.01%
=======================================
Files 44 44
Lines 6770 6770
=======================================
Hits 6094 6094
Misses 553 553
Partials 123 123
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
|
The link check failure is unrelated and will be fixed by #351 |
umbynos
approved these changes
Mar 15, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
1.17 is now the preferred Go version for Arduino tooling projects.