Skip to content
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: remove the deprecated runner_user_data output variable #1032

Merged
merged 2 commits into from
Nov 13, 2023

Conversation

ryancausey
Copy link
Contributor

@ryancausey ryancausey commented Nov 8, 2023

Description

Depending on the value of the output a call to nonsensitive is needed. Instead of introducing a conditional call, we remove the output variable. The value is still written to a local file, see debug.write_runner_user_data_to_file.

Closes #1031.

Migrations required

YES - any use of the runner-user-data output must be changed to use var.debug.write_runner_user_data_to_file. As this is used for debug only, it shouldn't be a problem for your live environment.

Verification

None. Just removing the output variable.

Copy link
Contributor

github-actions bot commented Nov 8, 2023

Hey @ryancausey! 👋

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:

  • the problem being solved
  • the best way a reviewer and you can test your changes

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:

  • /help: notifies a maintainer to help you out

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.

@ryancausey ryancausey force-pushed the fix/remove-nonsensitive-output branch from 32f78ad to 16325a8 Compare November 8, 2023 19:36
@ryancausey
Copy link
Contributor Author

I just noticed #1018 and #1019, so I've changed this to always mark this variable as sensitive.

@kayman-mk
Copy link
Collaborator

As this variable is already deprecated and used for debugging only, we should simply delete it (like in #1019). Users can set debug.write_runner_user_data_to_file to true to write the data to the local disk.

outputs.tf Outdated Show resolved Hide resolved
@ryancausey ryancausey force-pushed the fix/remove-nonsensitive-output branch 2 times, most recently from 5601972 to 157f354 Compare November 13, 2023 08:25
@ryancausey ryancausey changed the title fix: remove nonsensitive call from runner_user_data output variable fix: remove the deprecated runner_user_data output variable Nov 13, 2023
@ryancausey ryancausey requested a review from kayman-mk November 13, 2023 08:26
BREAKING CHANGE: This removes the deprecated runner_user_data output
variable. Use var.debug.write_runner_user_data_to_file instead.
@ryancausey ryancausey force-pushed the fix/remove-nonsensitive-output branch from 157f354 to 109626d Compare November 13, 2023 08:42
@kayman-mk kayman-mk merged commit 4e22a6c into cattle-ops:main Nov 13, 2023
18 checks passed
@kayman-mk
Copy link
Collaborator

Thanks for improving the module, @ryancausey

kayman-mk pushed a commit that referenced this pull request Nov 14, 2023
🤖 I have created a release *beep* *boop*
---


##
[7.2.2](7.2.1...7.2.2)
(2023-11-14)


### Bug Fixes

* remove the deprecated runner_user_data output variable
([#1032](#1032))
([4e22a6c](4e22a6c))
* retry the jq installation in case of errors
([#1033](#1033))
([1ab5690](1ab5690))

---
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>
@ryancausey ryancausey deleted the fix/remove-nonsensitive-output branch December 14, 2023 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Using nonsensitive in runner_user_data variable causes terraform plan to fail
2 participants