Fix invalid tester build version prefix #121
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
Previously, the workflow name value was used as a component of the "PACKAGE_NAME_PREFIX" used to add identifying information to the version output and file names of tester builds. That happened to work when used with the "test" name of the source workflow. However, due to a lack of quoting in the build commands, once the tester build operation was moved to a dedicated workflow with a more descriptive name, it broke the build. Example: task: [dist:Windows_32bit] docker run -v `pwd`/..:/home/build -w /home/build \ -e CGO_ENABLED=1 \ docker.elastic.co/beats-dev/golang-crossbuild:1.16.4-main \ --build-cmd "go build -o dist/arduino-lint_windows_386/arduino-lint.exe -ldflags ' -X github.com/arduino/arduino-lint/internal/configuration.Version=Publish Tester Build-fd29502e32d5386607787a5e82e058dffda5a63a-git-snapshot -X github.com/arduino/arduino-lint/internal/configuration.Commit=fd29502 -X github.com/arduino/arduino-lint/internal/configuration.Timestamp=2021-08-05T22:23:50Z '" \ -p "windows/386" zip arduino-lint_Publish Tester Build-fd29502e32d5386607787a5e82e058dffda5a63a-git-snapshot_Windows_32bit.zip arduino-lint_windows_386/arduino-lint.exe ../LICENSE.txt -j sha256sum arduino-lint_Publish Tester Build-fd29502e32d5386607787a5e82e058dffda5a63a-git-snapshot_Windows_32bit.zip >> Publish Tester Build-fd29502e32d5386607787a5e82e058dffda5a63a-git-snapshot-checksums.txt Although it could be supported with appropriate quoting, the use of the workflow name doesn't really make sense in this application. The sole use of the workflow name should be to identify the workflow to humans. It's not really suitable for machine consumption such as file names. So the best fix for this specific bug is to hard code the identifier in the prefix, retaining the original "test" for consistency.
per1234
added
type: imperfection
umbynos
approved these changes
Aug 6, 2021
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.
Previously, the workflow name value was used as a component of the "PACKAGE_NAME_PREFIX" used to add identifying information to the version output and file names of tester builds. That happened to work when used with the "test" name
of the source workflow. However, due to a lack of quoting in the build commands, once the tester build operation was moved to a dedicated workflow with a more descriptive name, it broke the build.
Example:
Although it could be supported with appropriate quoting, the use of the workflow name doesn't really make sense in this application. The sole use of the workflow name should be to identify the workflow to humans. It's not really suitable for
machine consumption such as file names. So the best fix for this specific bug is to hard code the identifier in the prefix, retaining the original "test" for consistency.