-
-
Notifications
You must be signed in to change notification settings - Fork 329
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.
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
fix: delete the 'runner_config_toml_rendereded' output variable #1019
Conversation
Hey @JulianCBC! 👋 Thank you for your contribution to the project. Please refer to the contribution rules for a quick overview of the process. Make sure that this PR clearly explains:
With submitting this PR you confirm that you hold the rights of the code added and agree that it will published under this LICENSE. The following ChatOps commands are supported:
Simply add a comment with the command in the first line. If you need to pass more information, separate it with a blank line from the command. This message was generated automatically. You are welcome to improve it. |
The fix is definitely needed. But the code looks rather complicated: Maybe we find another solution to export the Runner's configuration? This was the original intend of this output variable. But I guess they will all have this sensitivity problem. |
I completely agree: the goal of this pull request was to start the discussion and to that end I chose the "smallest" fix that wasn't completely insane or removing functionality. We definitely need a better solution than this. Some options from my perspective:
|
Voting for 2 and delete the output. The module writes the configuration to a local file. This should be sufficient for debugging. Would be nice to get rid of sensitive/non sensitive. And I wouldn't consider this as a major change, as it is for debugging only. |
This is saved to a file so users can view it there if needed.
d3b8ecc
to
70868a7
Compare
Thanks @kayman-mk, I've re-done this pull request to just delete the output variable. |
PR updated as we use it as commit message. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for fixing this bug.
🤖 I have created a release *beep* *boop* --- ## [7.2.1](7.2.0...7.2.1) (2023-11-10) ### Bug Fixes * delete the 'runner_config_toml_rendereded' output variable ([#1019](#1019)) ([3f7eaea](3f7eaea)) * run the GitLab Runner deregistration process at shutdown ([#1034](#1034)) ([68884fd](68884fd)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Signed-off-by: Niek Palm <dev.npalm@gmail.com> Co-authored-by: cattle-ops-releaser-2[bot] <134548870+cattle-ops-releaser-2[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Thanks @kayman-mk for your help in sorting this out and fixing up the PR message. |
Description
Due to calls to
nonsensitive
in case the data is sensitive or not calling the function in the other case, the code gets very complex. The output variablerunner_config_toml_rendereded
was introduced for easier debugging, but we still have the option to write the whole Runner configuration to a local file (debug.write_runner_config_to_file
).This "fixers" that issue by just deleting the output variable.
Closes #1018
Migrations required
Usually not. For debugging purposes, set the
debug.write_runner_config_to_file
totrue
. The configuration is written to a file on your local disk (directorydebug/
)Verification
Only linted as this is only deleting an output variable.