Manage the "yq" tool dependency #652
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
The "yq" tool is used by the `poetry:install` task. Previously, the tool was not managed in any way. The GitHub Actions workflows used whichever version of yq happened to be installed on the runner machine. This meant that the GitHub Actions workflows could break at any time through the "yq" installation on the runner machine being updated to an incompatible version. And the task would fail entirely if executed on a Windows runner (as is done by the "Test Integration" workflow) due GitHub not providing an installation of "yq" on that runner. The contributors used whichever version of "yq" happened to be installed on their machine. This meant that they might get different results from that produced by the environment of the GitHub Actions workflows. If they didn't already have an installation, they would need to manually install the dependency. The better solution is to take the same approach for managing the "yq" dependency as is done for the project's other dependencies: * Install a specific version of "yq" according to a single source of versioning data. * Use the Dependabot service to get automated update pull requests.
per1234
added
type: enhancement
This was referenced Sep 16, 2025
I discovered that I was mistaken about this effect. Although Dependabot does provide update PRs when tool dependencies are managed via the alternative provisional " |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 "yq" tool is used by the
poetry:installtask.Previously, the tool was not managed in any way.
The GitHub Actions workflows used whichever version of yq happened to be installed on the runner machine. This meant that the GitHub Actions workflows could break at any time through the "yq" installation on the runner machine being updated to an incompatible version.
And the task would fail entirely if executed on a Windows runner (as is done by the "Test Integration" workflow) due GitHub not providing an installation of "yq" on that runner.
The contributors used whichever version of "yq" happened to be installed on their machine. This meant that they might get different results from that produced by the environment of the GitHub Actions workflows. If they didn't already have an installation, they would need to manually install the dependency.
The better solution is to take the same approach for managing the "yq" dependency as is done for the project's other dependencies: