Add infrastructure for defining -ldflags for go test run #153
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
This variable has a specific usage in the release-go-task template for injecting versioning information during the builds. The `go:build` task is intended for use by all Go application projects, even if the release system is not applicable. For this reason, the "go-task" template taskfile contains an empty `LDFLAGS` taskfile variable definition, which may be defined with any `-ldflags` flag the project might need for its build, or left empty if the project does not have any need for such a flag. The usage of this variable might not be clear to the template user, so a "TODO" comment is added, which will be removed during the installation of the "template" in a project. In the event the variable it is left empty, its presence in the taskfile might be the source of confusion, and so a permanent explanatory comment is also provided.
The `go:build` task has an `LDFLAGS` taskfile template variable, which is currently used by some projects to inject the versioning information while building via an `-ldflags` flag. `go test` has undocumented support for an `-ldflags` flag as well. Projects might find it useful to be able to set the value of string variables in the code while running the tests. To provide support by the template task for this use case, a `TEST_LDFLAGS` taskfile template variable is added to the `go test` command in the `go:test` task, as well as empty definition of the variable. This can be left empty if the project doesn't have any need for the capability.
per1234
added
type: enhancement
rsora
approved these changes
Aug 27, 2021
silvanocerza
approved these changes
Aug 27, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
The
go:buildtask has anLDFLAGStaskfile template variable, which is currently used by some projects (example) to inject the versioning information while building via an-ldflagsflag.go testhas undocumented support for an-ldflagsflag as well. Projects might find it useful to be able to set the value of string variables in the code while running the tests (example). To provide support by the template task for this use case, aTEST_LDFLAGStaskfile template variable is added to thego testcommand in thego:testtask, as well as empty definition of the variable. This can be left empty if the project doesn't have any need for the capability.